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

update readme #47

Merged
merged 2 commits into from
Dec 3, 2021
Merged

update readme #47

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea6395d
update readme
joselvelez Dec 1, 2021
c11d108
Merge branch 'master' into master
Dec 3, 2021
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
41 changes: 37 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,45 @@
# web3-ui

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
This will be a library made up of UI components specifically crafted for web3 use cases.

[Read the RFC](https://forum.developerdao.com/t/rfc-web3-ui-a-web3-specific-ui-library)
_In Development 🏗️_

A library of UI components specifically crafted for web3 use cases.

## The Motive

## The RFC

- [RFC: web3-ui (a web3-specific UI library)](https://forum.developerdao.com/t/rfc-web3-ui-a-web3-specific-ui-library/565)

## Technologies

This project is built with the following open source libraries, frameworks and languages.
| Tech | Description |
| --------------------------------------------- | ----------------------------------------- |
| [React](https://reactjs.org/) | Front end user interface |
| [ChakraUI](https://chakra-ui.com/) | A simple & modular component library |
| [TypeScript](https://www.typescriptlang.org/) | Static type-checking programming language |

## How to Contribute

1. Read the [CONTRIBUTING GUIDELINES](/CONTRIBUTING.md).

2. Check the [ISSUES](https://github.com/Developer-DAO/web3-ui/issues) for a TO-DO list of problems to fix and things to add. Read every issue to understand what's needed and whether it's something you can help with.

3. Ask other contributors to see if no one has taken the issue yet. If you're interested in tackling such a feature and it's still available, we will assign you to the task.

4. Fork the repo and create your own branch using `git checkout -b your_branch_name`. Remember to use a branch name that describes WHAT you're doing/fixing.

5. Setup your local development environment. Instructions [here](/CONTRIBUTING.md#installation)

6. Once your work is done with the local copy of the repo, don't hesitate to draw a pull request. We'll gladly revise and push as deemed fit.

7. Feel free to add new issues as you read the code and find inconsistencies and/or possible features that may add up to the website. Follow the labeling standards to make it easier to understand what you're proposing.

[Contribute to the project!](CONTRIBUTING.md)
8. Document changes and/or issues clearly. Make it easy for everyone involved to understand your ideas/changes.

## Contributors ✨

Expand All @@ -29,4 +62,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!