Skip to content

Commit 917d9b2

Browse files
committed
Add CONTRIBUTING.md and update README.md
Created CONTRIBUTING.md file to outline contribution guidelines for the community Updated README.md with improved project description, installation instructions, and community links Ensured consistency between public-facing information and internal technical specifications
1 parent 74d9aa0 commit 917d9b2

File tree

2 files changed

+62
-2
lines changed

2 files changed

+62
-2
lines changed

CONTRIBUTING.md

Whitespace-only changes.

README.md

Lines changed: 62 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,62 @@
1-
# ln1-public
2-
Public repository for DataHive's LN1 Legalese Node. This repo contains open-source components and documentation for the legal data indexing and curation system powering the DataHive network. Explore, contribute, and help shape the future of decentralized legal intelligence.
1+
# LN1 Legalese Node - Public Repository
2+
3+
Welcome to the public repository for DataHive's LN1 Legalese Node. This repo contains open-source components and documentation for the legal data indexing and curation system powering the DataHive network.
4+
5+
## About LN1 Legalese Node
6+
7+
The LN1 Legalese Node is a crucial component of the DataHive ecosystem, designed to index, curate, and process legal data in a decentralized manner. It plays a key role in building and maintaining the Legal Intelligence Layer of the DataHive network.
8+
9+
## Technical Specifications
10+
11+
For a comprehensive overview of the LN1 Legalese Node's architecture, components, and functionalities, please refer to our [Technical Specifications Document](https://docs.google.com/document/d/1s_JQxCLm1U5Ep_hBoslx_0-BcIZO66ulur7ioJrxy8E/edit).
12+
13+
This document covers:
14+
- System Architecture
15+
- Core Components
16+
- Data Processing and Storage
17+
- Security and Compliance Features
18+
- Performance Metrics
19+
- And more...
20+
21+
Please note that this document is continuously updated as the project evolves.
22+
23+
## Guide for Node Operators
24+
25+
If you're a node operator planning to maintain your own hardware, you can easily set up the LN1 Legalese Node using our provided installers:
26+
27+
### For Windows and Linux Users:
28+
1. Download the appropriate installer for your operating system from our [releases page](https://github.com/datahiv3/ln1-public/releases).
29+
2. Run the installer and follow the on-screen instructions to complete the setup.
30+
31+
### For Advanced Users or Other Operating Systems:
32+
If you prefer manual installation or are using a different operating system:
33+
34+
1. Ensure you have Git installed on your system.
35+
2. Open your terminal or command prompt.
36+
3. Clone the repository:
37+
4. Git clone https://github.com/datahiv3/ln1-public.git
38+
5. 5. Follow the manual setup instructions provided in the `INSTALLATION.md` file.
39+
40+
For detailed configuration instructions and system requirements, please refer to our [Technical Specifications Document](https://docs.google.com/document/d/1s_JQxCLm1U5Ep_hBoslx_0-BcIZO66ulur7ioJrxy8E/edit).
41+
42+
If you encounter any issues during the installation process, please check our [Troubleshooting Guide](TROUBLESHOOTING.md) or open an issue in this repository.
43+
44+
45+
## Contributing
46+
47+
We welcome contributions from the community! If you're interested in contributing to the LN1 Legalese Node project, please read our [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to get started.
48+
49+
## Support
50+
51+
If you encounter any issues or have questions, please open an issue in this repository or contact our support team at [support email/link].
52+
53+
## License
54+
55+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
56+
57+
## Stay Connected
58+
59+
- Follow us on [Twitter](https://twitter.com/GetDataHive)
60+
- Join our [Telegram community](https://t.me/datahiveofficial)
61+
62+
Thank you for your interest in the LN1 Legalese Node project. Together, we're shaping the future of decentralized legal intelligence!

0 commit comments

Comments
 (0)