revamp readme #2474
Open
revamp readme #2474
+146
−72
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
miparnisari
commented
Jun 27, 2025
README.md
Outdated
| @@ -258,6 +191,66 @@ To get an understanding of integrating an application with SpiceDB, you can foll | |||
| [Buf Registry]: https://buf.build/authzed/api/docs | |||
| [Postman]: https://www.postman.com/authzed/workspace/spicedb/overview | |||
|
|
|||
| ### Deploying to Production | |||
|
|
|||
| The core SpiceDB service has been utilized in production by Authzed since 2021 so you can be confident that it is battle-tested. | |||
miparnisari
force-pushed
the
readme-revamp
branch
3 times, most recently
from
e96bd69 to
db01eeb
Compare
miparnisari
commented
Jul 2, 2025
README.md
Outdated
Comment on lines
207
to
293
| #### Telemetry | ||
|
|
||
| SpiceDB collects anonymous telemetry data to help us understand how the community is using SpiceDB and to help us prioritize features. This telemetry is opt-out and can be disabled via setting `--telemetry-endpoint=""`. For more information on the telemetry we collect, see [this](./telemetry.md). |
miparnisari
force-pushed
the
readme-revamp
branch
3 times, most recently
from
9be6ea7 to
b728131
Compare
miparnisari
commented
Jul 3, 2025
| @@ -192,7 +151,7 @@ Container images are available for AMD64 and ARM64 architectures on the followin | |||
| [Docker] users can run the latest SpiceDB container with the following: | |||
|
|
|||
| ```command | |||
| docker run --rm -p 50051:50051 authzed/spicedb serve --grpc-preshared-key "somerandomkeyhere" | |||
| docker run --rm -p 50051:50051 -p 8443:8443 authzed/spicedb serve --http-enabled true --grpc-preshared-key "somerandomkeyhere" | |||
There was a problem hiding this comment.
Every developer has curl installed, so it's super easy to run the code snippets below.
miparnisari
force-pushed
the
readme-revamp
branch
from
b728131 to
16f0764
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goal: someone with absolutely zero knowledge on SpiceDB or Zanzibar should be able to read this readme top to bottom and have their questions answered: what is this? and how do i try it out?
Solution: