From 49896506433bfe3a3be2f9ba35a70fda9d26fa50 Mon Sep 17 00:00:00 2001 From: sagautam5 Date: Sun, 28 Apr 2024 12:54:57 +0545 Subject: [PATCH] update docs --- CONTRIBUTING.md | 2 ++ README.md | 6 +++++- docs/docker/setup.md | 4 +++- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5157a2e..094e1e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,6 +47,8 @@ Before submitting a pull request: - Make sure contribution align with phpstan standards. You can run following command to ensure this. ```sh vendor/bin/phpunit analyse --level=8 src/ + vendor/bin/phpunit analyse --level=5 tests/ + ``` - Check the codebase to ensure that your feature doesn't already exist. diff --git a/README.md b/README.md index bf70f07..c4dbce7 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ Image Source: [Wikipedia(Administrative divisions of Nepal)](https://simple.wiki - 7.3 - 7.4 - Current **dev-master** has been tested on following php versions. + Current **v2.0.0** has been tested on following php versions. - 8.0 - 8.1 @@ -60,7 +60,11 @@ Example: http://127.0.0.1/local-states-nepal/demo Demo Video: https://www.loom.com/share/a8c3d825a9ee41a9817b24645453e979 + +Additionally, you can setup with Docker and visit [localstates.test](http://localstates.test) to view the demo. Here is guideline for setting up with Docker. + [Local setup with Docker](./docs/docker/setup.md) + ## Support Currently, This library supports following two languages. diff --git a/docs/docker/setup.md b/docs/docker/setup.md index e2168a0..9690f46 100644 --- a/docs/docker/setup.md +++ b/docs/docker/setup.md @@ -22,7 +22,9 @@ In order to verify contribution align with php unit tests and php stan standards vendor/bin/phpunit -vendor/bin/phpstan analyse --level=9 +vendor/bin/phpstan analyse --level=8 src/ + +vendor/bin/phpstan analyse --level=5 tests/ ## Docker Images