mirror of
https://github.com/woodchen-ink/CoverView.git
synced 2025-07-18 14:01:56 +08:00
updated readme
This commit is contained in:
parent
4593452353
commit
ed1c66d1ca
97
README.md
97
README.md
@ -1,71 +1,56 @@
|
|||||||
|
<p align="center">
|
||||||
|
<img width="300px" src="https://user-images.githubusercontent.com/47467468/90390293-b8eeb280-e0a8-11ea-82cf-9efa89773094.png" align="center" alt="" />
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://github.com/rutikwankhade/CoverView"><img src="https://img.shields.io/github/stars/rutikwankhade/CoverView.svg?style=social&label=Star"></a>
|
||||||
|
<a href="https://github.com/rutikwankhade/CoverView"><img src="https://badges.frapsoft.com/os/v1/open-source.svg?v=103"></a>
|
||||||
|
<a href="https://lbesson.mit-license.org"><img src="https://img.shields.io/badge/License-MIT-blue.svg"></a>
|
||||||
|
|
||||||
|
|
||||||
<!--
|
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
<p align="center">🛠 Create awesome cover images for your blog posts quickly.</p>
|
||||||
|
<p align="center">
|
||||||
|
<img src="https://user-images.githubusercontent.com/47467468/90472913-36650200-e13f-11ea-9e8a-bef4bb14dc84.gif" height="auto" width="400px" margin="20px">
|
||||||
|
</p>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## ⚡ Features
|
||||||
|
- 🛠 Create cover images for your blogs quick and easily
|
||||||
|
- 🌈 Choose different background-color
|
||||||
|
- ✨ Choose from 15 different background patterns
|
||||||
|
- 💾 Download cover images in `.png` format
|
||||||
|
|
||||||
|
## 👩💻 Developing
|
||||||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
|
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
|
||||||
|
|
||||||
## Available Scripts
|
|
||||||
|
|
||||||
In the project directory, you can run:
|
|
||||||
|
|
||||||
### `npm start`
|
```shell
|
||||||
|
git clone https://github.com/your/awesome-project.git
|
||||||
|
cd CoverView/
|
||||||
|
npm start
|
||||||
|
```
|
||||||
|
|
||||||
Runs the app in the development mode.<br />
|
|
||||||
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
|
|
||||||
|
|
||||||
The page will reload if you make edits.<br />
|
## 👇 Contributing
|
||||||
You will also see any lint errors in the console.
|
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
||||||
|
|
||||||
### `npm test`
|
|
||||||
|
|
||||||
Launches the test runner in the interactive watch mode.<br />
|
1. Fork it (<https://github.com/rutikwankhade/CoverView/fork>)
|
||||||
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
|
2. Create your feature branch (`git checkout -b feature/fooBar`)
|
||||||
|
3. Commit your changes (`git commit -am 'Add some fooBar'`)
|
||||||
|
4. Push to the branch (`git push origin feature/fooBar`)
|
||||||
|
5. Create a new Pull Request
|
||||||
|
|
||||||
### `npm run build`
|
|
||||||
|
|
||||||
Builds the app for production to the `build` folder.<br />
|
## 🙏 Acknowledgments
|
||||||
It correctly bundles React in production mode and optimizes the build for the best performance.
|
- [react-component-export-image](https://www.npmjs.com/package/react-component-export-image)
|
||||||
|
- [Hero Patterns](https://www.heropatterns.com/)
|
||||||
|
|
||||||
The build is minified and the filenames include the hashes.<br />
|
Don't forget to leave a ⭐ if you found this useful.
|
||||||
Your app is ready to be deployed!
|
|
||||||
|
|
||||||
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
|
|
||||||
|
|
||||||
### `npm run eject`
|
|
||||||
|
|
||||||
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
|
|
||||||
|
|
||||||
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
|
|
||||||
|
|
||||||
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
|
|
||||||
|
|
||||||
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
|
|
||||||
|
|
||||||
## Learn More
|
|
||||||
|
|
||||||
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
|
|
||||||
|
|
||||||
To learn React, check out the [React documentation](https://reactjs.org/).
|
|
||||||
|
|
||||||
### Code Splitting
|
|
||||||
|
|
||||||
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
|
|
||||||
|
|
||||||
### Analyzing the Bundle Size
|
|
||||||
|
|
||||||
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
|
|
||||||
|
|
||||||
### Making a Progressive Web App
|
|
||||||
|
|
||||||
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
|
|
||||||
|
|
||||||
### Advanced Configuration
|
|
||||||
|
|
||||||
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
|
|
||||||
|
|
||||||
### Deployment
|
|
||||||
|
|
||||||
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
|
|
||||||
|
|
||||||
### `npm run build` fails to minify
|
|
||||||
|
|
||||||
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify -->
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user