Merge pull request #1728 from sphinx-labs/pate/update-readme

docs: Update readme

README.md

@@ -27,15 +27,12 @@ Deployments with Sphinx are a three-step process:
 
 * **No Lock-In**: You can execute deployments from your local machine without using the Sphinx DevOps Platform. These deployments are executed in the exact same manner as they would be executed with the DevOps Platform, including identical contract addresses. This includes networks that the DevOps Platform doesn't currently support.
 
-## Request Access
-
-Sphinx is currently invite-only. [Request access on our website](https://sphinx.dev).
+## Self Hosting
+Sphinx is designed to be used with the [Sphinx Platform](https://github.com/sphinx-labs/sphinx-platform) which you must host yourself. You can find information on running the Sphinx Platform locally and recommendations for hosting in the [Sphinx Platform documentation](https://github.com/sphinx-labs/sphinx-platform/blob/main/docs).
 
 ## Pricing
 
-Pricing for the DevOps Platform is on the [website's landing page](https://sphinx.dev).
-
-Sphinx does not charge for the [Deploy CLI Command](https://github.com/sphinx-labs/sphinx/blob/main/docs/cli-deploy.md), which executes the deployment from your local machine without using the DevOps Platform. However, since it doesn't use the DevOps Platform, you'll need native gas tokens for the deployment.
+Sphinx is free and open source. You must host the Sphinx platform yourself to be able to use it.
 
 ## Demo
 
@@ -83,9 +80,8 @@ A demo of the DevOps Platform is on the [website's landing page](https://sphinx.
 
 Please feel free to reach out to us in our [Discord](https://discord.gg/7Gc3DK33Np) to request a feature!
 
-## Networks Supported by the DevOps Platform
-
-> Note: You can use the [Deploy CLI Command](https://github.com/sphinx-labs/sphinx/blob/main/docs/cli-deploy.md) to deploy on networks that the DevOps Platform doesn't currently support.
+## Networks Supported
+The Sphinx core contracts are deployed on the following networks.
 
 - Ethereum
 - Optimism
@@ -142,23 +138,13 @@ Test networks:
 - Mantle Sepolia
 - Astar zKyoto
 
-More networks are on the way! Please reach out to us in our [Discord](https://discord.gg/7Gc3DK33Np) if there are networks you'd like us to add.
-
 ## Contributors
 
 [@rpate97](https://github.com/RPate97)\
 [@sam-goldman](https://github.com/sam-goldman)\
 [@smartcontracts](https://github.com/smartcontracts)\
 [Wonderland](https://defi.sucks/)
 
-## Contributing
-
-Contributions to Sphinx are greatly appreciated! Please read our [contributing guide](https://github.com/sphinx-labs/sphinx/blob/main/CONTRIBUTING.md) to get started. Then, check out the list of [Good First Issues](https://github.com/sphinx-labs/sphinx/contribute). Let us know if you have any questions!
-
-## Reach Out
-
-If you have any questions or feature requests, send us a message in our [Discord!](https://discord.gg/7Gc3DK33Np)
-
 ## License
 
 We use the Gnosis Safe contracts as a library. These contracts are licensed under [LGPL v3](https://github.com/safe-global/safe-contracts/blob/main/LICENSE). You can access them in [Gnosis Safe's repository](https://github.com/safe-global/safe-contracts).

docs/cli-existing-project.md

@@ -34,7 +34,7 @@ In this guide, you'll propose the deployment on the command line and then approv
 
 ## 1. Prerequisites
 
-* You must have an invite link to the DevOps platform because it's currently invite-only. [Request access on Sphinx's website.](https://sphinx.dev)
+* You must have a running instance of the [Sphinx Platform](https://github.com/sphinx-labs/sphinx-platform/block/main/docs/local.md).
 * You must have an existing Foundry project that includes a Forge script. If you don't, we recommend following the [Getting Started in a New Repository guide](https://github.com/sphinx-labs/sphinx/blob/main/docs/cli-quickstart.md) instead.
 * You must have an RPC node provider API key. If you don't already have one, we recommend [Alchemy](https://www.alchemy.com/) or [Infura](https://www.infura.io/).
 * You must have an account that exists on live networks. This account will own your Gnosis Safe.
@@ -183,6 +183,11 @@ You'll need to update the `projectName` field to match the Project Name you crea
 
 ## 10. Add environment variables
 
+Add your Sphinx instance url to your environment file:
+```
+SPHINX_MANAGED_BASE_URL=<your_sphinx_instance_url>
+```
+
 Get your Sphinx API Key from the Sphinx UI and add it as an environment variable:
 ```
 SPHINX_API_KEY=<your_api_key>

docs/cli-quickstart.md

@@ -18,12 +18,13 @@ In this guide, you'll create a sample project, propose it on the command line, a
 4. [Install dependencies](#4-install-dependencies)
 5. [Create a new Sphinx project](#5-create-a-new-sphinx-project)
 6. [Initialize Sphinx](#6-initialize-sphinx)
-7. [Propose on testnets](#7-propose-on-testnets)
-8. [Next steps](#8-next-steps)
+7. [Add your Sphinx Platform instance url](#7-add-your-sphinx-platform-instance-url)
+8. [Propose on testnets](#8-propose-on-testnets)
+9. [Next steps](#9-next-steps)
 
 ## 1. Prerequisites
 
-* You must have an invite link to the DevOps platform because it's currently invite-only. [Request access on Sphinx's website.](https://sphinx.dev)
+* You must have a running instance of the [Sphinx Platform](https://github.com/sphinx-labs/sphinx-platform/block/main/docs/local.md).
 * You must have a basic understanding of how to use Foundry and Forge scripts. Here are the relevant guides in the Foundry docs:
   * [Getting Started with Foundry](https://book.getfoundry.sh/getting-started/first-steps)
   * [Writing Deployment Scripts with Foundry](https://book.getfoundry.sh/tutorials/solidity-scripting)
@@ -100,7 +101,13 @@ After you run the command, you'll notice several new files:
 - `.env`: A sample `.env` file that contains your credentials.
 - `.gitignore`: A sample `.gitignore` file that contains files and directories generated by Sphinx, Foundry, and Node.
 
-## 7. Propose on testnets
+## 7. Add your Sphinx Platform instance url
+Add your Sphinx instance URL to your environment file:
+```
+SPHINX_MANAGED_BASE_URL=<your_sphinx_instance_url>
+```
+
+## 8. Propose on testnets
 
 Copy and paste one of the following commands to propose your deployment with the DevOps Platform.
 
@@ -123,7 +130,7 @@ Here are the steps that occur when you run this command:
 
 When the proposal is finished, go to the [Sphinx UI](https://sphinx.dev) to approve the deployment. After you approve it, you can monitor the deployment's status in the UI while it's executed.
 
-## 8. Next steps
+## 9. Next steps
 
 Congrats, you've finished your first deployment with Sphinx!