Merge pull request #26 from ideal-lab5/docs/readme-licence

docs: improve readme
ideal-lab5 · Oct 16, 2024 · 9e0ee3c · 9e0ee3c
2 parents 879ab54 + cd9cf98
commit 9e0ee3c
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 4 deletions.
diff --git a/docs/murmur/README.md b/docs/murmur/README.md
@@ -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.
 
@@ -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).
diff --git a/docs/murmur/package.json b/docs/murmur/package.json
@@ -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",

diff --git a/test-utils/README.md b/test-utils/README.md
@@ -1,6 +1,6 @@
 # Murmur test utilities
 
-Various test utilities for murmur.
+Various test utilities for Murmur.
 
 ## Contributing