-
Notifications
You must be signed in to change notification settings - Fork 2
Description
Please improve the contents in readme as this is the first impression anyone gets when he see your project this should be clean and neat with only required contents
Take a look at reference README : https://github.com/vmware/pg_rewind/blob/master/README
Improvement points:
- No need to use headers and big fonts keep it simple
- write brief description for only necessary things
for eaxample:
The content of introduction which you have written can be written in following manner:
pgreport is a tool for generating statistic analysis of postgresql.conf parameters and kernel parameters for efficient use of your environment. It examines the environment and produces the report showing recommended values for each parameter. Current it works only for standalone machine
this is for just example purpose and lot more needs to be added into this
- Always write the correct names , they have a long history behind them, that will reflect you quality of work and respect towards them have a look at link :
for example:
pgreport not Pgreport
PostgreSQL not Postgresql
postgresql.conf not Postgresql.cong
Red Hat not Redhat
- Add download information, if anyone gets your repository though git protocol then he should find download link in readme file, this will also make you git repository popular :p
- Installation
Add a line that you need to have python installed o your system
can we make it as executable ?
for usage can be example:
$ chmod +x pgreport.py
$ ./pgreport $PGDATA/postgresql.conf - Add a brief information about how it operates
etc...