Update readme and troubleshooting (#1929)
Add downloads badge, add link to contributing to readme. Add common issues section in troubleshooting
This commit is contained in:
parent
77e9e43e06
commit
a50ffba3b1
|
@ -1,4 +1,5 @@
|
|||
# :lipstick: [{{package.name}}](https://github.com/Glavin001/atom-beautify)
|
||||
[![apm](https://img.shields.io/apm/dm/atom-beautify.svg)](https://atom.io/packages/atom-beautify)
|
||||
[![Greenkeeper badge](https://badges.greenkeeper.io/Glavin001/atom-beautify.svg)](https://greenkeeper.io/)
|
||||
[![GitHub issues](https://img.shields.io/github/issues/Glavin001/atom-beautify.svg?style=flat-square)](https://github.com/Glavin001/atom-beautify/issues)
|
||||
[![GitHub stars](https://img.shields.io/github/stars/Glavin001/atom-beautify.svg?style=flat-square)](https://github.com/Glavin001/atom-beautify/stargazers)
|
||||
|
@ -203,6 +204,8 @@ See [`docs/troubleshooting.md`](docs/troubleshooting.md).
|
|||
|
||||
## Contributing
|
||||
|
||||
See [`CONTRIBUTING.md`](CONTRIBUTING.md).
|
||||
|
||||
[See all contributors on GitHub](../../graphs/contributors).
|
||||
|
||||
Please update the [CHANGELOG.md](CHANGELOG.md),
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
# :lipstick: [atom-beautify](https://github.com/Glavin001/atom-beautify)
|
||||
[![apm](https://img.shields.io/apm/dm/atom-beautify.svg)](https://atom.io/packages/atom-beautify)
|
||||
[![Greenkeeper badge](https://badges.greenkeeper.io/Glavin001/atom-beautify.svg)](https://greenkeeper.io/)
|
||||
[![GitHub issues](https://img.shields.io/github/issues/Glavin001/atom-beautify.svg?style=flat-square)](https://github.com/Glavin001/atom-beautify/issues)
|
||||
[![GitHub stars](https://img.shields.io/github/stars/Glavin001/atom-beautify.svg?style=flat-square)](https://github.com/Glavin001/atom-beautify/stargazers)
|
||||
|
@ -318,6 +319,8 @@ See [`docs/troubleshooting.md`](docs/troubleshooting.md).
|
|||
|
||||
## Contributing
|
||||
|
||||
See [`CONTRIBUTING.md`](CONTRIBUTING.md).
|
||||
|
||||
[See all contributors on GitHub](../../graphs/contributors).
|
||||
|
||||
Please update the [CHANGELOG.md](CHANGELOG.md),
|
||||
|
|
|
@ -16,3 +16,9 @@ The debugging results will be copied to your clipboard.
|
|||
3. Create a file in your new Gist called `debug.md`.
|
||||
4. Paste your debugging results from Atom beautify into `debug.md` file in your Gist.
|
||||
5. Add a link to your Gist in your new Issue.
|
||||
|
||||
## Common Issues
|
||||
|
||||
> I receive an error when I try to install or update Atom Beautify
|
||||
|
||||
Run `apm clean` from your terminal, then retry
|
Loading…
Reference in New Issue