Skip to content

Commit b0d0494

Browse files
committed
docs: update README.md
1 parent 1c2e35b commit b0d0494

1 file changed

Lines changed: 15 additions & 10 deletions

File tree

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Endstone Python Example Plugin
22

3-
Welcome to the Example Python plugin for Endstone servers.
3+
Welcome to the example Python plugin for Endstone servers.
44

55
## Prerequisites
66

@@ -11,15 +11,15 @@ Welcome to the Example Python plugin for Endstone servers.
1111

1212
```
1313
python-example-plugin/
14-
├── src/ # Main source directory
15-
│ └── endstone_python_example_plugin/ # Directory for the plugin package
16-
│ ├── __init__.py # Initializer for the package, importing ExamplePlugin class from example_plugin.py
17-
│ ├── example_plugin.py # Implementation of ExamplePlugin class
18-
│ └── python_command.py # Custom command executor for /python
19-
├── .gitignore # Git ignore rules
20-
├── LICENSE # License details
21-
├── README.md # This file
22-
└── pyproject.toml # Plugin configuration file which specifies the entrypoint
14+
├── src/ # Main source directory
15+
│ └── endstone_example_plugin/ # Directory for the plugin package
16+
│ ├── __init__.py # Initializer for the package, importing ExamplePlugin class from example_plugin.py
17+
│ ├── example_plugin.py # Implementation of ExamplePlugin class
18+
│ └── python_command.py # Custom command executor for /python
19+
├── .gitignore # Git ignore rules
20+
├── LICENSE # License details
21+
├── README.md # This file
22+
└── pyproject.toml # Plugin configuration file which specifies the entrypoint
2323
```
2424

2525
## Getting Started
@@ -62,6 +62,11 @@ python-example-plugin/
6262
- [Using TestPyPI](https://packaging.python.org/en/latest/guides/using-testpypi/)
6363
- [Publishing package distribution releases using GitHub Actions CI/CD workflows](https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/)
6464

65+
## Documentation
66+
67+
For a deeper dive into the Endstone API and its functionalities, refer to the main
68+
Endstone [documentation](https://endstone.readthedocs.io) (WIP).
69+
6570
## License
6671

6772
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)