docs: update readme

This commit is contained in:
tristan 2019-09-18 15:12:14 +08:00
parent 30d5d19cd4
commit 5302da03a3
2 changed files with 24 additions and 6 deletions

View File

@ -1,6 +1,6 @@
# <img src="demo/logo.png" alt="Logo" width="50"> Chinese Color
> [中文 README.MD](README.zh.md)
> [中文文档](README.zh.md)
[Chinese Color Cheatsheet](https://works.yangerxiao.com/chinese-colors/)
@ -10,16 +10,32 @@
- Build with react.js
- PWA supported
<img src="demo/pwa.jpg" alt="PWA Logo" width="300">
<img src="demo/pwa.jpg" alt="PWA Logo" width="300">
- Responsive (Mobile First)
<img src="demo/m.png" alt="Mobile UI" width="300">
<img src="demo/m.png" alt="Mobile UI" width="300">
- Highlight the selected color
- Classify the colors
- Copy HEX
- Add to favorites
- Wallpaper (not stable, welcome [feedback](https://github.com/zerosoul/chinese-colors/issues)). <img src="demo/screenshot.png" alt="screen shot" width="300">
- Wallpaper (not stable, welcome [feedback](https://github.com/zerosoul/chinese-colors/issues)).
<img src="demo/screenshot.png" alt="screen shot" width="300">
## Technology Stack & Thanks
- [create-react-app](https://github.com/facebook/create-react-app)
- [react.js](https://reactjs.org)
- [styled-components](https://styled-components.com): CSS-IN-JS Best Practice
- eslint + prettier: for better code
- husky + commitlint: for better git commit format
- [html2canvas](http://html2canvas.hertzen.com/)
- [pinyin](https://github.com/hotoo/pinyin): convert Han to pinyin
- [react-copy-to-clipboard](https://github.com/nkbt/react-copy-to-clipboard): enable copy
- Thanks the great Open Source
## Changelog

View File

@ -32,15 +32,17 @@
- 颜色数据来源:[中国传统颜色](http://blog.sina.com.cn/s/blog_5c3b139d0101deia.html)
- UI参考[一个日本传统颜色网站](http://nipponcolors.com/)
## 技术栈
- [create-react-app](https://github.com/facebook/create-react-app): 大家都在用的 react 项目构建架子
- [react](https://reactjs.org): 最流行的前端 UI 构建语言
- redux + react-redux: 最流行的 react 状态管理解决方案
- [styled-components](https://styled-components.com): react 中 css 解决方案CSS-IN-JS 最佳实践
- eslint + prettier: 为了更好地编码
- husky + commitlint: 为了更好地 GIT 提交
- [html2canvas](http://html2canvas.hertzen.com/)
- [pinyin](https://github.com/hotoo/pinyin): 汉字转拼音
- [react-copy-to-clipboard](https://github.com/nkbt/react-copy-to-clipboard): 开启复制功能
- 感谢伟大的互联网,感谢各种开源作品
## 更新日志