Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sagautam5 committed Apr 28, 2024
1 parent fb2ee1f commit 4989650
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/

```
<!-- - Make sure unit tests are passed on pipeline after your updates. -->
- Check the codebase to ensure that your feature doesn't already exist.
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
4 changes: 3 additions & 1 deletion docs/docker/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 4989650

Please sign in to comment.