diff --git a/README.md b/README.md index 3fbb55f1..a8f24e53 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ # soroban-rpc RPC Server for Soroban Contracts. + + +This repo is home to the Soroban RPC, soon to be renamed Stellar RPC. The RPC provides information that the network currently has in its view. It has the ability to send a transaction to the network, and query the network for the status of previously sent transactions, and is meant to be simple, scalable, and familiar to blockchain developers. + + +## RPC Methods +To learn about the RPC methods, please see our [RPC Developer Docs](https://developers.stellar.org/network/soroban-rpc/methods). + +## To Use an Ecosystem RPCs +To enable autocomplete permanently, run: +To use RPC from an ecosystem provider for futurenet, testnet, or mainnet, please see our list of [Ecosystem RPC Providers](https://developers.stellar.org/network/soroban-rpc/rpc-providers). + +## Run Your Own RPC +If you are interested in running your own RPC, please review the [Admin Guide](https://developers.stellar.org/network/soroban-rpc/admin-guide). + +## Latest Release +For latest releases, please see +[releases](https://github.com/stellar/soroban-rpc/releases). + +## Upcoming Features +For upcoming features, please see the [project +board](https://github.com/orgs/stellar/projects/37). + +## Report Bugs or Request Features +To report bugs or request features, please open an issue on the official [RPC +repo](https://github.com/stellar/soroban-rpc). + +## To Contribute +Please fork this see `good first issues` on +[here](https://github.com/stellar/soroban-rpc/contribute). + +Developer Docs: https://developers.stellar.org/docs