Merge pull request #150 from DeterminateSystems/development-docs

Move development docs into separate Markdown file
DeterminateSystems · Jul 10, 2024 · d3b4b64 · d3b4b64
2 parents 99d17ab + 96c3ec0
commit d3b4b64
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -75,20 +75,9 @@ jobs:
 | `source-tag`           | The tag of `flakehub-push` to use. Conflicts with all other `source-*` options.                                                                                                                                                                                                                                                                                                                                                                                         | string        |           |                            |
 | `source-url`           | A URL pointing to a `flakehub-push` binary. Overrides all other `source-*` options.                                                                                                                                                                                                                                                                                                                                                                                     | string        |           |                            |
 
-## Development against a local Flakehub server
-
-Assuming the dev environment is running as described in the flakehub repo:
-
-```bash
-export FLAKEHUB_PUSH_GITHUB_TOKEN="<secret>"
-cargo run -- \
-  --visibility public \
-  --tag v0.1.0 \
-  --repository DeterminateSystems/nix-installer \
-  --git-root ../nix-installer \
-  --jwt-issuer-uri http://localhost:8081/jwt/token \
-  --host http://localhost:8080
-```
+## Developing `flakehub-push`
+
+See the [development docs](./docs/development.md).
 
 [cache]: https://determinate.systems/posts/flakehub-cache-beta
 [flakehub]: https://flakehub.com

diff --git a/docs/development.md b/docs/development.md
@@ -0,0 +1,15 @@
+## Developing `flakehub-push`
+
+You can run `flakehub-push` against a Flakehub server running locally.
+Assuming the dev environment is running as described in the FlakeHub repo:
+
+```bash
+export FLAKEHUB_PUSH_GITHUB_TOKEN="<secret>"
+cargo run -- \
+  --visibility public \
+  --tag v0.1.0 \
+  --repository DeterminateSystems/nix-installer \
+  --git-root ../nix-installer \
+  --jwt-issuer-uri http://localhost:8081/jwt/token \
+  --host http://localhost:8080
+```