Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README needs an update #89

Open
netsensei opened this issue Jan 27, 2019 · 0 comments
Open

README needs an update #89

netsensei opened this issue Jan 27, 2019 · 0 comments

Comments

@netsensei
Copy link
Contributor

The README.md is outdated and needs an update before releasing a 1.1 version of the application.

Detailed description

The README is outdated. These aspects need review:

  • The introduction text, needs to be more engaging and friendly. Maybe at the logo.
  • The "Features" section needs to be reviewed and expanded.
    • i.e. flexible user management, OAuth management, Records management, new formats, etc.
  • The "Requirements" section needs to be reviewed and expanded.
    • PHP 5.6 isn't supported anymore (due to EOL PHP 5.6)
  • The "Installation" section needs to be reviewed and expanded.
  • The "Usage" section needs to be a reference to documentation pages in Github Wiki and on http://thedatahub.github.io
  • The "Testing" section should just refer to running PHPUnit tests (no more bash scripts)
  • Front-end coding: leave "as-is" this is OK for now.

We also may look at adding badges like packagist.org. See: https://github.com/badges/shields We don't want to overload with shields and badges, but having relevant ones may help adoption. Ma

Context

A great, attractive looking README is important because it can drive adoption and boost confidence in the application development.

See: https://github.com/noffle/art-of-readme

Possible implementation

Draft a decent README.

@netsensei netsensei mentioned this issue Jan 27, 2019
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant