diff --git a/README.md b/README.md index 9b06214..31eb901 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ the ini formatting. ## Usage -#### via cli interface: +#### via cli: ```console amphc @@ -81,7 +81,7 @@ Static and Dynamic Analysis for nginx-amplify-agent Health Status optional arguments: -h, --help show this help message and exit - -V, --version show program's version information and exit + -V, --version show amphc version number -v, --verbose show all check logs -d, --plain suppress decorating logs -c CONFIG_FILE, --config CONFIG_FILE @@ -112,7 +112,7 @@ verification methods: 17) verify_sys_time ``` -#### via api interface: +#### via api: ```python import amplifyhealthcheck as amphc @@ -138,4 +138,12 @@ amphc.verify_outbound_tls_access() amphc.verify_proc_sys_access() amphc.verify_dns_resolver() amphc.verify_metrics_collection() -``` \ No newline at end of file +``` + +## Contributing + +- Fork it ( https://github.com/hiradyazdan/nginx-amplify-agent-health-check/fork ) +- Create your feature branch with your initials (git checkout -b hy/my-new-feature) +- Commit your changes (git commit -am 'Add some feature') +- Push to the branch (git push origin my-new-feature) +- Create new Pull Request \ No newline at end of file diff --git a/circle.yml b/circle.yml index 11855be..2d8f34d 100644 --- a/circle.yml +++ b/circle.yml @@ -9,4 +9,4 @@ dependencies: test: override: - coverage run --source=amplifyhealthcheck setup.py test - - COVERALLS_REPO_TOKEN=$COVERALLS_REPO_TOKEN coveralls \ No newline at end of file + - coveralls \ No newline at end of file diff --git a/setup.py b/setup.py index 4940693..6dff00e 100644 --- a/setup.py +++ b/setup.py @@ -1,6 +1,7 @@ from setuptools import setup classifiers = [ + 'Intended Audience :: Developers', 'License :: OSI Approved :: MIT License', 'Operating System :: POSIX' ] + [