diff --git a/README.md b/README.md index a171893..4022209 100644 --- a/README.md +++ b/README.md @@ -11,19 +11,25 @@ Mix: ![Cup of caffee]() + ![Bullet delete]() ![Cup of Matcha latte]() ![Cup of Tea]() ![Cup of water]() -## 🚀 How to use +##   How to use * Clone or fork the repository. * Download files from the [icons](./icons/) folder. -* (Soon) ~~Get the Figma UI Kit!~~ ![All available icons](./public/available-icons.png) -## Contributing 🧑‍🎨 +###  Roadmap + +* (Soon) Designers: Get the Figma UI Kit +* (Soon) Access to more decorators +* (Soon) Access to variants +* (Soon) Access to parts + +##   Contributing Reports, Requests and Contributions are welcomed to this project! I believe that healthy debate and disagreement are essential to a healthy project and community. However, it is never ok to be disrespectful. -### 🖐️ I would like to report a bug or suggest something! +###  I would like to report a bug or suggest something! The issue section is the right place for you to describe your problem. Specific rules applies, and not following them may result in the closing of the issue. * Issue must have a label related to your topic @@ -31,11 +37,11 @@ The issue section is the right place for you to describe your problem. Specific * Issue may be flagged as _duplicate_ if the topic is already discussed on another issue. * There is no garanties that an Issue will be resolved. I have limited bandwidth. -### 🪄 Can I create an icon too? +###  Can I create an icon too? Sure! Please *Fork* → *Create* → *Push* → *Pull Request*, follow the [Pull Request & commits guidelines](#pull-request-and-commit-guidelines), and the [Icon Design guidelines](#icon-design-guidelines) below. -### 🩹 I have fixed this icon, how can I give it back? +###  I have fixed this icon, how can I give it back? Thank you! Please *Fork* → *Patch* → *Push* → *Pull Request* and follow the [Pull Request & commits guidelines](#pull-request-and-commit-guidelines), and the [Icon Design guidelines](#icon-design-guidelines) below. @@ -52,11 +58,11 @@ Thank you! Please *Fork* → *Patch* → *Push* → *Pull Request* and follow th - Icon improvement based on existing icons must be as close as possible to the original design, especially at 16×16px. - Icon must render without visual artefact in today's broswer such as WebKit, Blink, Gecko. (Test your icons) -## License +##   License This project is licensed under the [**Creative Commons BY 4**](https://creativecommons.org/licenses/by/4.0/) license. This content is distributed in the hope that it will be useful, but **without any warranty**; without even the implied warranty of **merchantability** or **fitness for a particular purpose**. -## Acknowlegements +##  Acknowlegements The Original *FamFamFam Silk* icon pack ([github](https://github.com/markjames/famfamfam-silk-icons) • [website](http://www.famfamfam.com/lab/icons/silk/)) remains the property of Mark James. Mark, please have my thanks and salute for your great work.