Merge pull request #163 from JoeHut/jh/docs

Update Getting Started Documentation to reflect current state of implementation
helsing-ai · Nov 6, 2023 · 25cc3d6 · 25cc3d6
2 parents 2f8b0b3 + c2f3296
commit 25cc3d6
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/docs/src/getting-started/first-steps.md b/docs/src/getting-started/first-steps.md
@@ -46,11 +46,19 @@ your protocol buffers as a package.
 Let us define a dependency of the webserver on a hypothetical library
 called `user` in the `datatypes` repository.
 
-This is done by editing the manifest or by invoking `buffrs add`:
+This is done by invoking `buffrs add`:
+
+```bash
+$ buffrs add --registry https://your.registry.com datatypes/user@=0.1.0
+```
+
+The result is a dependency in the `Proto.toml`:
 
 ```toml
-[dependencies]
-user = { version = "0.1.0", repository = "datatypes" }
+[dependencies.user]
+version = "=0.1.0"
+repository = "datatypes"
+registry = "https://your.registry.com/"
 ```
 
 ### Going further

diff --git a/docs/src/getting-started/installation.md b/docs/src/getting-started/installation.md
@@ -16,7 +16,7 @@ artifactory instance (which will be replaced by the Buffrs Registry in Q4
 Logging in to your instance is done using the following `buffrs` command:
 
 ```bash
-buffrs login --url https://<organization>.jfrog.io/artifactory
+buffrs login --registry https://<organization>.jfrog.io/artifactory
 ```
 
 You will be prompted for an artifactory identity token which you can create