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

Added documentation and License for the project #23

Merged
merged 2 commits into from
Dec 5, 2024

Conversation

walesch-yan
Copy link
Collaborator

This PR adds some documentation using mkdocs and an automatic documentation deploy bot, as well as an MIT License to the project.

Closes #20

@marcus-oscarsson marcus-oscarsson merged commit 06c9b0c into main Dec 5, 2024
1 check passed
@marcus-oscarsson
Copy link
Member

Super nice !, well done.

---

## How to Get Started
Ready to dive in? Follow our [Installation Guide](installation.md) and [Setup Instructions](usage/setup.md).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice :)

---

## Contribute to the Project
We’d love your contributions! Whether you’re reporting an issue, suggesting a feature, or submitting a pull request, your help makes a difference.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent ! 👍

}
```

#### Example Redis Pub/Sub communication
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, nice with an example like this !

@walesch-yan walesch-yan deleted the yw-documentation branch December 5, 2024 13:36
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.

Documentation of the repository
2 participants