-
Notifications
You must be signed in to change notification settings - Fork 6
Open
Description
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.
- We don't use "fixtures" anymore during installation.
- The app:setup command will be gradually deprecated (see: Move to phing for application setup #58)
- The creation of a Mongo user and db needs a better explanation due to Require MongoDB password and user #63
- 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.
Metadata
Metadata
Assignees
Labels
No labels