Skip to content

Commit

Permalink
[docs] Improve README
Browse files Browse the repository at this point in the history
- Removes suggestions
- Add link to HACKING in Contribution guide
- Link to LICENSE file
  • Loading branch information
captn3m0 committed Apr 12, 2021
1 parent 517a54c commit b2a4ed8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 17 deletions.
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,14 @@ releaseImage: https://jkrowling.com/timeturner-releases.png
Time-turners are no longer released, and the last known stable release was in HP.5 release.
```

File a Pull Request with this file created, and Netlify will provide a preview URL for the same. Once merged, it goes live on the website.
File a Pull Request with this file created, and Netlify will provide a preview URL for the same. Once the pull request is merged, the changes are automatically deployed on the website.

You can visit <https://github.com/endoflife-date/endoflife.date/new/master/tools> to directly create your file.

## Hacking

If you'd like to work on the site internals, see [HACKING.md](https://github.com/endoflife-date/endoflife.date/blob/master/HACKING.md).

## Code of Conduct

Please note that this project is released with a [Contributor Code of Conduct](CODE-OF-CONDUCT.md). By participating in this project you agree to abide by its terms.
21 changes: 5 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,17 @@
# endoflife.date [![Netlify Status](https://api.netlify.com/api/v1/badges/a4c194ea-370a-436d-b58f-b1b7eadd88a3/deploy-status)](https://app.netlify.com/sites/endoflife/deploys) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) ![powered by Jekyll](https://img.shields.io/badge/powered_by-Jekyll-blue.svg) [![Website shields.io](https://img.shields.io/website-up-down-green-red/https/endoflife.date.svg)](https://endoflife.date/) [![made-with-Markdown](https://img.shields.io/badge/Made%20with-Markdown-1f425f.svg)](http://commonmark.org) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE-OF-CONDUCT.md)
# endoflife.date

Keep track of various EOL dates as they are approaching. Visit <https://endoflife.date> for a list of supported tools.
[![Netlify Status](https://api.netlify.com/api/v1/badges/a4c194ea-370a-436d-b58f-b1b7eadd88a3/deploy-status)](https://app.netlify.com/sites/endoflife/deploys) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) ![powered by Jekyll](https://img.shields.io/badge/powered_by-Jekyll-blue.svg) [![Website shields.io](https://img.shields.io/website-up-down-green-red/https/endoflife.date.svg)](https://endoflife.date/) [![made-with-Markdown](https://img.shields.io/badge/Made%20with-Markdown-1f425f.svg)](http://commonmark.org) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE-OF-CONDUCT.md)

Add more by filing a PR on GitHub.

Inspired by my [rant on twitter](https://twitter.com/captn3m0/status/1110504412064239617) on how various languages get this wrong.

## Suggestion

The reason this site exists is because this information is very often hidden away. If you're releasing something on a regular basis:

1. List only supported releases.
2. Give EoL dates/policy if possible.
3. Hide unsupported releases behind a few extra clicks.
4. Mention security/active release difference if needed.
Keep track of various End of Life dates as they are approaching. Visit <https://endoflife.date> for a list of supported tools. A [lot of languages and tools get this wrong](https://twitter.com/captn3m0/status/1110504412064239617). endoflife.date collates this data and presents it in an easily accessible format, with URLs that are easy to guess and remember.

## Contributing

Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details. Please note that this project is released with a [Contributor Code of Conduct](CODE-OF-CONDUCT.md). By participating in this project you agree to abide by its terms.

## HACKING
## Working on the Code

If you'd like to hack on how the site gets built, see [HACKING.md](HACKING.md).

## License

Licensed under the [MIT License](https://nemo.mit-license.org/). See LICENSE file for details.
Licensed under the [MIT License](LICENSE).

0 comments on commit b2a4ed8

Please sign in to comment.