Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Readme update #27

Merged
merged 1 commit into from
Apr 5, 2024
Merged

Readme update #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Thanks for thinking about this :)

You can contribute to this library by filing issues, bugs and Pull requests.

### Code contribution

- Open issue/Pull request regarding proposed change.
- If your proposed change is approved, Fork this repo and do changes.
- Open Pull request against latest *development* branch. Add nice description in PR.
- And that's it!

### Code contribution checklist

- New code addition/deletion should not break existing flow of a system.
- All tests should be passed.
- Verify `./gradlew detekt` is passing before creating a Pull request.
16 changes: 12 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# 📘 Reusable Components library for Compose

![master CI](https://github.com/LinX64/Reusable/actions/workflows/publish.yaml/badge.svg)
![develop CI](https://github.com/LinX64/Reusable/actions/workflows/ci.yaml/badge.svg)
[![Maven Central](https://img.shields.io/maven-central/v/io.github.linx64/reusablecomponents.svg)](https://central.sonatype.com/artifact/io.github.linx64/reusablecomponents/overview)
<div align="center">
<img src="https://github.com/LinX64/Reusable/actions/workflows/publish.yaml/badge.svg" alt="master CI">
<img src="https://github.com/LinX64/Reusable/actions/workflows/ci.yaml/badge.svg" alt="develop CI">
<a href="https://central.sonatype.com/artifact/io.github.linx64/reusablecomponents/overview">
<img src="https://img.shields.io/maven-central/v/io.github.linx64/reusablecomponents.svg?label=Maven%20Central&logo=android&style=flat-square" alt="Maven Central">
</a>
</div>

This library is a treasure trove of reusable components tailored for Jetpack Compose, designed to
simplify the creation of complex interfaces. It's your go-to toolkit for crafting visually stunning
Expand Down Expand Up @@ -57,9 +61,13 @@ And that's it! You have a scrollable screen with a few buttons. You can customiz
passing your own `modifier` to it. The same goes for the buttons, you can pass your own `modifier`
to it.

**Important note:** To use the Preview components, you'll nned to add your own theme first, then use the
**Important note:** To use the Preview components, you'll need to add your theme first, then use the
components to create your UI.

## 🙋‍Contributing

Please Read [contribution guidelines](CONTRIBUTING.md) for more information regarding contribution.

## License

This library is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for more
Expand Down