docs: streamline README and move setup instructions#383
Conversation
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull Request Overview
This PR streamlines the README by removing setup instructions and moving them to a dedicated getting started guide. The change improves documentation organization by separating high-level project overview from detailed setup procedures.
- Moved detailed Maven/Gradle setup instructions from README to new getting started guide
- Simplified README to focus on project overview with reference to setup documentation
- Removed redundant external project references from examples section
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/GETTING_STARTED.md | New comprehensive setup guide with prerequisites, build instructions, and dependency configuration |
| README.md | Streamlined overview with reference to getting started guide and simplified examples section |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| Replace `[VERSION]` with the latest release number from the [releases page](https://github.com/tcheeric/nostr-java/releases). | ||
|
|
||
| Examples are available in the [`nostr-java-examples`](../nostr-java-examples) module. |
There was a problem hiding this comment.
The relative path '../nostr-java-examples' may not resolve correctly from the docs/ directory. Consider using './nostr-java-examples' or provide the full repository path for consistency with other documentation links.
| Examples are available in the [`nostr-java-examples`](../nostr-java-examples) module. | |
| Examples are available in the [`nostr-java-examples`](https://github.com/tcheeric/nostr-java/tree/main/nostr-java-examples) module. |
Summary
Testing
mvn -q verify(fails: Could not find a valid Docker environment; see logs)https://chatgpt.com/codex/tasks/task_b_68a48db89dc883318bd941a41ac2046f