Skip to content

Commit feed3db

Browse files
authored
chore(docs): update README (#236)
* chore(docs): update README
1 parent 0ac19aa commit feed3db

1 file changed

Lines changed: 34 additions & 4 deletions

File tree

README.md

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,30 @@
11
# OpenFGA API
2-
This project contains the definitions of [Protocol Buffers](https://developers.google.com/protocol-buffers/) used by OpenFGA.
2+
3+
The OpenFGA API [Protocol Buffers](https://developers.google.com/protocol-buffers/) definitions.
4+
5+
## About
6+
[OpenFGA](https://openfga.dev) is an open source Fine-Grained Authorization solution inspired by [Google's Zanzibar paper](https://research.google/pubs/pub48190/). It was created by the FGA team at [Auth0/Okta](https://auth0.com) based on [Auth0 Fine-Grained Authorization (FGA)](https://fga.dev), available under [a permissive license (Apache-2)](https://github.com/openfga/rfcs/blob/main/LICENSE) and welcomes community contributions.
7+
8+
OpenFGA is designed to make it easy for application builders to model their permission layer, and to add and integrate fine-grained authorization into their applications. OpenFGA’s design is optimized for reliability and low latency at a high scale.
9+
10+
## Usage
311

412
[Buf](https://github.com/bufbuild/buf) is used to manage, package, and generate source code from the protocol buffer definitions. The API definitions
513
are pushed to the [`buf.build/openfga/api`](https://buf.build/openfga/api) repository in the Buf Registry.
614

7-
## Building the Generated Sources
15+
You can find various SDKs autogenerated by buf based on the protobuf definitions here: https://buf.build/openfga/api/sdks/main:protobuf
16+
17+
For example, to import the definitions in Go you can do so via the following command:
18+
19+
```shell
20+
go get go.buf.build/openfga/go/openfga/api
21+
```
22+
23+
If you are looking for the currently supported OpenFGA HTTP SDKs, you can find them here: https://github.com/openfga/sdk-generator#currently-supported-sdks
24+
25+
## Contributing
26+
27+
### Building the Generated Sources
828
To generate source code from the protobuf definitions contained in this project you can run the following command:
929

1030
> **Note**: You must have [Buf CLI](https://docs.buf.build/installation) installed to run the following command.
@@ -17,7 +37,7 @@ The command above will generate source code in the `proto/` directory. It will a
1737
that files requiring auto-generation after `.proto` changes have been updated. There are some cases where that git hook
1838
may be overly strict. In those cases you can bypass it with `commit --no-verify`.
1939

20-
## Use the generated sources in OpenFGA
40+
### Use the generated sources in OpenFGA
2141

2242
1. Generate the sources as above
2343
2. In the `proto` directory execute the following commands:
@@ -30,7 +50,7 @@ may be overly strict. In those cases you can bypass it with `commit --no-verify`
3050
replace github.com/openfga/api/proto => /path/to/proto
3151
```
3252

33-
## Generating OpenAPI Documentation
53+
### Generating OpenAPI Documentation
3454
To generate the OpenAPI documentation from the protobuf sources you can run the following commands:
3555

3656
> **Note**: You must have [jq](https://jqlang.github.io/jq/download/) installed to run the `format` step below
@@ -45,3 +65,13 @@ Or you can just use
4565
```bash
4666
make
4767
```
68+
69+
See [CONTRIBUTING](https://github.com/openfga/.github/blob/main/CONTRIBUTING.md).
70+
71+
## Author
72+
73+
[OpenFGA](https://github.com/openfga)
74+
75+
## License
76+
77+
This project is licensed under the Apache-2.0 license. See the [LICENSE](https://github.com/openfga/api/blob/main/LICENSE) file for more info.

0 commit comments

Comments
 (0)