Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add initial documentation for Legion API to README.md #14

Merged
merged 1 commit into from
Dec 18, 2024

Conversation

kimitrii
Copy link
Owner

Changes Made

This PR adds the initial version of the documentation for the Legion API to the README file. It includes the following sections:

- Quick Start guide for running the API locally
- Security guidelines for reporting vulnerabilities
- Initial REST API details, including status code errors
- Error code definitions for common HTTP responses

Changes Type

  • Documentation update

Checklist:

  • The changes do not generate new error logs or warnings.
  • I have added tests that prove the fix or new feature works as expected.
  • Both new and existing tests pass locally.

@kimitrii kimitrii merged commit 8434540 into main Dec 18, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants