diff --git a/README.md b/README.md index c752221..ecd9d37 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ Setting up service bridge_celery... [12:00:00] ✓ Local worker started Service bridge_celery started! Setting up service bridge_flower... -[00:02:52] ✓ Flower started +[12:00:00] ✓ Flower started Service bridge_flower started! Performing system checks... diff --git a/docs/faq.md b/docs/faq.md index 9b751aa..b26efe6 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -6,10 +6,12 @@ When running locally, Bridge uses Docker to create and manage containers for Pos ### How does it work with deployments? -When you are ready to deploy, Bridge creates configuration files for Render that specify how to build and run your Django application alongside the same services. Bridge also writes a "Deploy to Render" button straight into your README for added convenience! +When you are ready to deploy, Bridge creates configuration files for Render that specify how to build and run your Django application alongside the same services. Bridge also writes a "Deploy to Render" button straight into your README for added convenience! You can deploy your application by clicking the 'Deploy to Render' button shown on your project's GitHub page. ### What if I don't need all the services that bridge provides? -- [for evan to fill out] + +Bridge is designed to be modular. You can configure only the services you need by creating or editing the `bridge.yaml` file that Bridge creates in your project root. By default, `enable_postgres: true` and `enable_worker: true` are set, but you can change these to `false` to prevent bridge from configuring Postgres and Celery respectively. + ### How can I stop the services that bridge spins up? `bridge stop` will stop all running services. diff --git a/docs/getting-started.md b/docs/getting-started.md index 1195237..3ffad5c 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -11,6 +11,7 @@ Client: ... ``` ## Installation +Install bridge from PyPI: ```bash pip install python-bridge ``` @@ -60,7 +61,9 @@ Bridge can also handle deployed configuration for your app as well! Simply run: bridge init render ``` You may be prompted for the entrypoint of your application and settings file if bridge cannot detect them. + Bridge will create all the configuration necessary for you to immediately deploy to [Render](https://render.com/). This includes a Blueprint `render.yaml` as well as build scripts and start scripts for your Django application. + After running `bridge init render`, commit the changes and visit your project on github. You will see the following button at the end of your README in the root of your repository: ![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)