Skip to content

Commit

Permalink
2954: Remove usage section and add link to reviewing
Browse files Browse the repository at this point in the history
  • Loading branch information
steffenkleinle committed Nov 19, 2024
1 parent 183b65c commit 34fbd11
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 12 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ React JS and React Native App for [Integreat](https://integreat-app.de), [Malte]
- [Project Structure](#project-structure)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Project setup](#project-setup)
- [Project Setup](#project-setup)
- [Further Reading](#further-reading)

## Contributing
Expand All @@ -27,7 +27,8 @@ First, make sure you have a look at our [conventions](docs/conventions.md).
You can contribute by:

- [Reporting bugs](docs/contributing.md#reporting-issues-and-bugs)
- [Creating Pull requests](docs/contributing.md#pull-requests)
- [Creating pull requests](docs/contributing.md#pull-requests)
- [Reviewing pull requests](docs/contributing.md#reviews)

If you want to know more about Integreat or if you want to join us, contact [Leandra](mailto:[email protected]),
[Steffen](mailto:[email protected]) or [our info mail](mailto:[email protected]) and visit our [website](https://integreat-app.de).
Expand Down
10 changes: 0 additions & 10 deletions assets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,3 @@ Normal icons are supposed to follow the following conventions:
- The SVG should be as simple and reduced as possible

If the icon has e.g. a build-config dependent background, you can use `fill="var(--theme-color, none)"`.

### Usage

To use icons (and other assets) in the code, add them to the corresponding assets files
for [web](../web/src/assets/index.ts) and/or [native](../native/src/assets/index.ts).
You can then simply use our custom `Icon`
components ([web](../web/src/components/base/Icon.tsx), [native](../native/src/components/base/Icon.tsx)).
They automatically set the default color, theme color and size and provide additional convenience props
(e.g. `directionDependent`, `reverse`).
If necessary, you can simply override styles using styled-components.

0 comments on commit 34fbd11

Please sign in to comment.