Skip to content

Commit

Permalink
docs:Update README.md (#888)
Browse files Browse the repository at this point in the history
- fixed downloadlink to figma file
- removed issues & bugs section, as the new sections under help & feedback, which we added as part of #428 are way more detailed and have a better user-flow

Signed-off-by: Thorben Hartmann <[email protected]>
  • Loading branch information
thrbnhrtmnn authored Feb 6, 2024
1 parent 1f3a446 commit 1d9d2ed
Showing 1 changed file with 2 additions and 8 deletions.
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,14 @@
- [Usage](#usage)
- [:white\_check\_mark: How to test](#white_check_mark-how-to-test)
- [:v: Contribute](#v-contribute)
- [:bug: Bugs and Issues](#bug-bugs-and-issues)
- [:page\_facing\_up: License](#page_facing_up-license)
- [:green\_heart: Code of conduct](#green_heart-code-of-conduct)


## :star: Introduction
B01LER is a fully customisable design system (DS) that enables you to easily create cohesive and consistent digital products across multiple platforms and brands.

B01LER provides pre-built components that exist in design in the form of a [component library in Figma](https://www.figma.com/file/zPHgVJFeLAhdM4MdOymhPb/B01LER--%5Bv0.1---alpha-release%5D?type=design&node-id=8941%3A1818&mode=design&t=owVepZzAwdrehnmL-1) (the link to the Figma file above is exclusively for members of the Accenture organization, while those outside the organization can download the file [here](https://boilerds.com/B01LER%20%20%5Bv0.1%20-%20alpha%20release%5D.fig)), as well as in code in a repository (the one you have opened right now), which is also [displayed in the web using Storybook](https://b01ler.onrender.com/). Both the components in design and in code are connected via a token system.
B01LER provides pre-built components that exist in design in the form of a [component library in Figma](https://www.figma.com/file/zPHgVJFeLAhdM4MdOymhPb/B01LER--%5Bv0.1---alpha-release%5D?type=design&node-id=8941%3A1818&mode=design&t=owVepZzAwdrehnmL-1) (the link to the Figma file above is exclusively for members of the Accenture organization, while those outside the organization can download the file [here](https://boilerds.com/B01LER-v1-alpha%20release.fig)), as well as in code in a repository (the one you have opened right now), which is also [displayed in the web using Storybook](https://b01ler.onrender.com/). Both the components in design and in code are connected via a token system.

A token system is a collection of values which represent the visual properties of a design system, such as typography, color and spacing.

Expand All @@ -55,7 +54,7 @@ Some articles claim, that Web Components are not accessible or that they are not


## :art: Resources
- [Check out our Figma File](https://www.figma.com/file/zPHgVJFeLAhdM4MdOymhPb/B01LER--%5Bv0.1---alpha-release%5D?type=design&node-id=8941%3A1818&mode=design&t=owVepZzAwdrehnmL-1) (the link to the Figma file above is exclusively for members of the Accenture organization, while those outside the organization can download the file [here](https://boilerds.com/B01LER%20%20%5Bv0.1%20-%20alpha%20release%5D.fig))
- [Check out our Figma File](https://www.figma.com/file/zPHgVJFeLAhdM4MdOymhPb/B01LER--%5Bv0.1---alpha-release%5D?type=design&node-id=8941%3A1818&mode=design&t=owVepZzAwdrehnmL-1) (the link to the Figma file above is exclusively for members of the Accenture organization, while those outside the organization can download the file [here](https://boilerds.com/B01LER-v1-alpha%20release.fig))
- [Have a look at our components in Storybook](https://b01ler.onrender.com/)


Expand Down Expand Up @@ -152,11 +151,6 @@ Note: This is not filled out yet!
For a detailed documentation on how to contribute to the B01LER project, have a look at our [contribution guide](./CONTRIBUTING.md).


## :bug: Bugs and Issues
If you would like to open an issue, you can gladly use [this page](https://github.com/deven-org/B01LER-Kitchen/issues).
But please, have a look at the [Contribute](./CONTRIBUTING.md) page before filing a bug.


## :page_facing_up: License
This project is licensed under the [MIT license](./LICENSE.md).

Expand Down

0 comments on commit 1d9d2ed

Please sign in to comment.