docs: enhance main README with comprehensive documentation #390
Conversation
VolodymyrBg
commented
Jan 31, 2025
VolodymyrBg
commented
- Add project status badges and key features section
- Include detailed contributing guidelines
- Add troubleshooting section with common solutions
- Improve documentation structure and readability
- Add additional resources and links
- Update formatting and visual presentation
- Add project status badges and key features section - Include detailed contributing guidelines - Add troubleshooting section with common solutions - Improve documentation structure and readability - Add additional resources and links - Update formatting and visual presentation
| Hemi is an EVM-compatible L2 blockchain that combines the security of Bitcoin with the programmability of Ethereum. | ||
| Hemi is an EVM-compatible L2 blockchain that combines the security of Bitcoin with the programmability of Ethereum. It provides a robust, scalable solution for decentralized applications while leveraging Bitcoin's proven security model. | ||
|
|
||
| [](https://github.com/hemilabs/heminetwork/blob/main/LICENSE) |
There was a problem hiding this comment.
We already have the license in the README so this just added clutter.
| @@ -1,6 +1,9 @@ | |||
| # ⚡️ The Hemi Network | |||
|
|
|||
| Hemi is an EVM-compatible L2 blockchain that combines the security of Bitcoin with the programmability of Ethereum. | |||
| Hemi is an EVM-compatible L2 blockchain that combines the security of Bitcoin with the programmability of Ethereum. It provides a robust, scalable solution for decentralized applications while leveraging Bitcoin's proven security model. | |||
There was a problem hiding this comment.
This is just adding marketing terms and does add to the readability or info in the readme.
| @@ -33,6 +36,14 @@ Hemi is an EVM-compatible L2 blockchain that combines the security of Bitcoin wi | |||
|
|
|||
| --- | |||
|
|
|||
| ## 🌟 Key Features | |||
There was a problem hiding this comment.
This just makes the doc longer.
| @@ -227,6 +235,48 @@ clean environment. It can be omitted. | |||
|
|
|||
| --- | |||
|
|
|||
| ## 🤝 Contributing | |||
There was a problem hiding this comment.
We already have a contributing doc linked.
|
|
||
| --- | ||
|
|
||
| <div align="center"> |
There was a problem hiding this comment.
We don't need html formatting or non-ascii here.
|
|
||
| <div align="center"> | ||
| <p>Built with ❤️ by the Hemi Labs team and contributors.</p> | ||
| <p>© 2024 Hemi Labs. All Rights Reserved.</p> |
There was a problem hiding this comment.
And the contents of this repository are MIT Licensed, not ARR.
| - [Official Documentation](https://docs.hemi.network) | ||
| - [API Reference](https://api.hemi.network) | ||
| - [Community Forum](https://forum.hemi.network) | ||
| - [Discord Community](https://discord.gg/hemi) |
There was a problem hiding this comment.
None of these links are exist, and our Discord server is hemixyz, not hemi.
|
Closing this since basically everything would need to be changed. Feel free to open an new PR with a more minimal set of fixes based on our comments here if you want. |
