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.

Sign up for GitHub

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

Jump to bottom

docs: improve readme #26

Merged
merged 3 commits into from
Oct 16, 2024
Merged

docs: improve readme #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
298d699
docs: add readme and license everywhere
juangirini Oct 16, 2024
3d0094d
chore: remove license files
juangirini Oct 16, 2024
cd9cf98
fix: readme link
juangirini Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/murmur/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Murmur Docs

This is the official documentation for the murmur protocol.
This is the official documentation for the Murmur protocol.

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

Expand Down Expand Up @@ -41,3 +41,15 @@ $ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

## Contributing

Contributions are welcome! Please open an issue or submit a pull request.

## License

This project is licensed under the Apache-2.0. See the [LICENSE](../../LICENSE) file for details.

## Contact

For any inquiries, please contact [Ideal Labs](https://idealabs.network).
5 changes: 3 additions & 2 deletions docs/murmur/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{
"name": "murmur",
"version": "0.0.0",
"name": "murmur-docs",
"version": "0.1.0",
"private": true,
"license": "Apache-2.0",
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
Expand Down
2 changes: 1 addition & 1 deletion test-utils/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Murmur test utilities

Various test utilities for murmur.
Various test utilities for Murmur.

## Contributing

Expand Down