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

chore: Update the README #675

Merged
merged 10 commits into from
Dec 18, 2024
Merged

chore: Update the README #675

merged 10 commits into from
Dec 18, 2024

Conversation

adizere
Copy link
Member

@adizere adizere commented Dec 12, 2024

Part of #375

New readme inspired from https://github.com/anton-rs/kona/tree/main


PR author checklist

@adizere adizere changed the title first pass on prepping the readme chore(code): first pass on prepping the readme Dec 12, 2024
@adizere adizere marked this pull request as ready for review December 12, 2024 19:39
@romac
Copy link
Member

romac commented Dec 17, 2024

The readme also needs a disclaimer stating something like that:

Malachite is pre-alpha software and still under heavy development. At this stage, it is not meant for use in production.
The software is provided "as is" and has not been externally audited. Use at your own risk.

@adizere
Copy link
Member Author

adizere commented Dec 17, 2024

The readme also needs a disclaimer stating something like that:

Malachite is pre-alpha software and still under heavy development. At this stage, it is not meant for use in production.
The software is provided "as is" and has not been externally audited. Use at your own risk.

Done

@romac romac changed the title chore(code): first pass on prepping the readme chore: Update the README Dec 17, 2024
@romac
Copy link
Member

romac commented Dec 17, 2024

Looks great, thanks!

[tg-url]: https://t.me/MalachiteLibrary
[tg-badge]: https://img.shields.io/badge/Malachite-Library-blue.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI+PHBhdGggZD0iTTEyIDI0YzYuNjI3IDAgMTItNS4zNzMgMTItMTJTMTguNjI3IDAgMTIgMCAwIDUuMzczIDAgMTJzNS4zNzMgMTIgMTIgMTJaIiBmaWxsPSJ1cmwoI2EpIi8+PHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik01LjQyNSAxMS44NzFhNzk2LjQxNCA3OTYuNDE0IDAgMCAxIDYuOTk0LTMuMDE4YzMuMzI4LTEuMzg4IDQuMDI3LTEuNjI4IDQuNDc3LTEuNjM4LjEgMCAuMzIuMDIuNDcuMTQuMTIuMS4xNS4yMy4xNy4zMy4wMi4xLjA0LjMxLjAyLjQ3LS4xOCAxLjg5OC0uOTYgNi41MDQtMS4zNiA4LjYyMi0uMTcuOS0uNSAxLjE5OS0uODE5IDEuMjI5LS43LjA2LTEuMjI5LS40Ni0xLjg5OC0uOS0xLjA2LS42ODktMS42NDktMS4xMTktMi42NzgtMS43OTgtMS4xOS0uNzgtLjQyLTEuMjA5LjI2LTEuOTA4LjE4LS4xOCAzLjI0Ny0yLjk3OCAzLjMwNy0zLjIyOC4wMS0uMDMuMDEtLjE1LS4wNi0uMjEtLjA3LS4wNi0uMTctLjA0LS4yNS0uMDItLjExLjAyLTEuNzg4IDEuMTQtNS4wNTYgMy4zNDgtLjQ4LjMzLS45MDkuNDktMS4yOTkuNDgtLjQzLS4wMS0xLjI0OC0uMjQtMS44NjgtLjQ0LS43NS0uMjQtMS4zNDktLjM3LTEuMjk5LS43OS4wMy0uMjIuMzMtLjQ0Ljg5LS42NjlaIiBmaWxsPSIjZmZmIi8+PGRlZnM+PGxpbmVhckdyYWRpZW50IGlkPSJhIiB4MT0iMTEuOTkiIHkxPSIwIiB4Mj0iMTEuOTkiIHkyPSIyMy44MSIgZ3JhZGllbnRVbml0cz0idXNlclNwYWNlT25Vc2UiPjxzdG9wIHN0b3AtY29sb3I9IiMyQUFCRUUiLz48c3RvcCBvZmZzZXQ9IjEiIHN0b3AtY29sb3I9IiMyMjlFRDkiLz48L2xpbmVhckdyYWRpZW50PjwvZGVmcz48L3N2Zz4K
[responsive]: https://informal.systems/blog/tendermint-responsiveness
[announcement]: https://informal.systems/blog/malachite-decentralize-whatever
Copy link
Member Author

Choose a reason for hiding this comment

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

This link will become live once we open source the codebase.

@adizere adizere enabled auto-merge (squash) December 18, 2024 09:08
@adizere adizere merged commit 364ea89 into main Dec 18, 2024
2 checks passed
@adizere adizere deleted the adi/readme branch December 18, 2024 09:09
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.

2 participants