Skip to content

Commit 991dfdb

Browse files
committed
docs: update readme
1 parent c550d1f commit 991dfdb

1 file changed

Lines changed: 16 additions & 8 deletions

File tree

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
Filament plugin for world data.
1313

1414
✅ Countries
15-
✅ Posts
15+
🟧 Geo and special regions (WIP)
16+
🟧 Posts (WIP)
1617
⏳ Other resources coming when needed ([suggest a feature](https://github.com/DataLinx/eclipsephp-world-plugin/discussions) and/or [hire us](https://www.datalinx.si))
1718

1819
## Requirements
@@ -38,21 +39,28 @@ Should you want to contribute, please see the development guidelines in the [Dat
3839

3940
### Development
4041

42+
1. All development is subject to our [PHP package development guidelines](https://github.com/DataLinx/php-package-template/blob/bc39ae340e7818614ae2aaa607e97088318dd754/docs/Documentation.md).
43+
2. Our [Filament app development docs](https://github.com/DataLinx/eclipsephp-core/blob/cae7143c8f745f142bba2bb4cf1483cf09401509/docs/Documentation.md) will also be helpful.
44+
3. Any PRs will generally need to adhere to these before being merged.
45+
4146
#### Requirements
4247
* Linux, Mac or Windows with WSL
4348
* [Lando](https://lando.dev/) (optional, but easier to start with)
4449

4550
#### Get started
4651
1. Clone the git repo
4752
2. Start the Lando container
48-
```shell
49-
lando start
50-
````
53+
```shell
54+
lando start
55+
````
5156
3. Install dependencies (this also runs the setup composer script)
52-
```shell
53-
lando composer install
54-
````
55-
4. Happy coding 😉
57+
```shell
58+
lando composer install
59+
````
60+
4. You can now develop and run tests. Happy coding 😉
61+
62+
💡 To manually test the plugin in the browser, see our [recommendation](https://github.com/DataLinx/eclipsephp-core/blob/main/docs/Documentation.md#-plugin-development), which is also [how Filament suggests package development](https://filamentphp.com/docs/3.x/support/contributing#developing-with-a-local-copy-of-filament).
63+
However, the plugin should be universal and not dependent on our app setup or core package.
5664

5765
### Changelog
5866
All notable changes to this project are automatically documented in the [CHANGELOG.md](CHANGELOG.md) file using the release workflow, based on the [release-please](https://github.com/googleapis/release-please) GitHub action.

0 commit comments

Comments
 (0)