diff --git a/README.md b/README.md index 145d196..89eb9ce 100644 --- a/README.md +++ b/README.md @@ -4,26 +4,28 @@ Rarible Multichain Protocol is a decentralized toolset that simplifies the way developers can work with NFTs. Protocol builds an abstraction layer for several blockchains and isolates the developer from their specifics with Multichain SDK. -Rarible Multichain SDK is fully blockchain-agnostic. You can find a list of supported blockchains on our [Features](https://docs.rarible.org/features/) page. +Rarible Multichain SDK is fully blockchain-agnostic. You can find a list of supported blockchains on our [Blockchains](https://docs.rarible.org/docs/supported-chains) page. ## How to start On [docs.rarible.org](https://docs.rarible.org/) you can find main information about Rarible Protocol. -* Read [Getting Started](https://docs.rarible.org/getting-started/quick-start/) guide to learn how to [Install Multichain SDK](https://docs.rarible.org/getting-started/quick-start/#installation), mint your first NFT and put it on sale -* Get better understanding of Rarible Multichain Protocol with [Protocol Overview](https://docs.rarible.org/overview/protocol-overview/) Chapter -* Learn how to use SDK with our [Reference](https://docs.rarible.org/reference/reference-overview/) -* Try using our [API](https://docs.rarible.org/api-reference/) -* Review successful cases from our partners using Rarible Multichain Protocol in [Use Cases](https://docs.rarible.org/use-cases/use-cases-overview/) section -* Try to look on fully functional [Example Application](https://github.com/rarible/example) +* Read [Getting Started](https://docs.rarible.org/reference/getting-started) guide to learn how to [Install Multichain SDK](https://docs.rarible.org/reference/getting-started#installation), query API and list NFT for sale. +* Get better understanding of Rarible Multichain Protocol with [Introduction](https://docs.rarible.org/docs/introduction) Chapter +* Learn how to use SDK with our [Reference](https://docs.rarible.org/reference/getting-started) +* Try using our [API](https://docs.rarible.org/reference/getitembyid) +* Review successful cases from our partners using Rarible Multichain Protocol in [Use Cases](https://docs.rarible.org/docs/wallets-portfolios) section +* Try to look on fully functional [React Example Application](https://github.com/rarible/sdk/tree/master/packages/example) ## Resources * [Github](https://github.com/rarible) — Rarible Protocol resources -* [Discord](https://discord.gg/raribleprotocol) — main place of DAO community +* [Discord](https://discord.com/invite/rarifoundation) — main discord of RARI Foundation +* [Telegra](https://t.me/+XPmJwyx2WN0xNjIy) - main telegram group of Rarible Protocol * [Rarible Youtube](https://www.youtube.com/c/Rarible) +* [Rarible Protocol Twitter](https://twitter.com/raribleprotocol) * [Rarible Twitter](https://twitter.com/rarible) -* [DAO Twitter](https://twitter.com/raribledao) +* [RARI Foundation Twitter](https://twitter.com/rarifoundation) ## Audits @@ -33,8 +35,8 @@ Rarible Protocol is audited. Check this report by [ChainSecurity.com](https://ch You are welcome to suggest features and report bugs found! You can do it here: -* [Submit an issue](https://github.com/rarible/protocol/issues) -* [Submit a question or suggestion](https://github.com/rarible/protocol/discussions) +* [Submit an issue](https://github.com/rarible/sdk/issues) +* [Submit a question or suggestion](https://docs.rarible.org/discuss) ## Contributing @@ -42,14 +44,6 @@ The codebase is maintained using the "contributor workflow" where everyone witho See more information on [CONTRIBUTING.md](CONTRIBUTING.md). -## Documentation - -[docs.rarible.org](https://docs.rarible.org/) is built using MkDocs and deployed on GitHub pages. The source files are written in Markdown and configured using `mkdocs.yml`. - -See more information on [protocol-mkdocs](protocol-mkdocs.md). - ## License -Rarible Protocol is available under [GPL v3](docs/LICENSE.md). - SDK and OpenAPI (with generated clients) are available under [MIT](docs/MIT-LICENSE.md).