Skip to content

Commit e0ac037

Browse files
jzelinskiejzelinskie
committed
*: add metadata, clean up readme a little
1 parent 3d98348 commit e0ac037

File tree

5 files changed

+97
-59
lines changed

5 files changed

+97
-59
lines changed

‎.github/workflows/cla.yaml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: "CLA"
3+
on: # yamllint disable-line rule:truthy
4+
issue_comment:
5+
types:
6+
- "created"
7+
pull_request_target:
8+
types:
9+
- "opened"
10+
- "closed"
11+
- "synchronize"
12+
merge_group:
13+
types:
14+
- "checks_requested"
15+
jobs:
16+
cla:
17+
name: "Check Signature"
18+
runs-on: "buildjet-2vcpu-ubuntu-2204"
19+
steps:
20+
- uses: "authzed/actions/cla-check@main"
21+
with:
22+
github_token: "${{ secrets.GITHUB_TOKEN }}"
23+
cla_assistant_token: "${{ secrets.CLA_ASSISTANT_ACCESS_TOKEN }}"

‎CODE-OF-CONDUCT.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Code of Conduct
2+
3+
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4+
5+
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
6+
7+
Examples of unacceptable behavior by participants include:
8+
9+
- The use of sexualized language or imagery
10+
- Personal attacks
11+
- Trolling or insulting/derogatory comments
12+
- Public or private harassment
13+
- Publishing other’s private information, such as physical or electronic addresses, without explicit permission
14+
- Other unethical or unprofessional conduct
15+
16+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct.
17+
By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project.
18+
Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
19+
20+
This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
21+
22+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
23+
24+
This Code of Conduct is adapted from the Contributor Covenant, version 1.2.0, available [here](https://www.contributor-covenant.org/version/1/2/0/code-of-conduct.html)

‎DCO

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Developer Certificate of Origin
2+
Version 1.1
3+
4+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
5+
1 Letterman Drive
6+
Suite D4700
7+
San Francisco, CA, 94129
8+
9+
Everyone is permitted to copy and distribute verbatim copies of this
10+
license document, but changing it is not allowed.
11+
12+
13+
Developer's Certificate of Origin 1.1
14+
15+
By making a contribution to this project, I certify that:
16+
17+
(a) The contribution was created in whole or in part by me and I
18+
have the right to submit it under the open source license
19+
indicated in the file; or
20+
21+
(b) The contribution is based upon previous work that, to the best
22+
of my knowledge, is covered under an appropriate open source
23+
license and I have the right under that license to submit that
24+
work with modifications, whether created in whole or in part
25+
by me, under the same open source license (unless I am
26+
permitted to submit under a different license), as indicated
27+
in the file; or
28+
29+
(c) The contribution was provided directly to me by some other
30+
person who certified (a), (b) or (c) and I have not modified
31+
it.
32+
33+
(d) I understand and agree that this project and the contribution
34+
are public and that a record of the contribution (including all
35+
personal information I submit with it, including my sign-off) is
36+
maintained indefinitely and may be redistributed consistent with
37+
this project or the open source license(s) involved.

‎NOTICE

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
SpiceDB
2+
Copyright 2022 Authzed, Inc
3+
4+
This product includes software developed at
5+
Authzed, Inc. (https://www.authzed.com/).

‎README.md

+8-59
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,18 @@
1-
<h1 align="center">
2-
<a href="https://authzed.com#gh-dark-mode-only" target="_blank">
3-
<img width="300" src="https://github.com/authzed/spicedb/assets/343539/82234426-468b-4297-8b5c-f06a44fe2278" alt="spicedb logo">
4-
</a>
5-
<a href="https://authzed.com#gh-light-mode-only" target="_blank">
6-
<img width="300" src="https://github.com/authzed/spicedb/assets/343539/312ff046-7076-4c30-afd4-2e3d86c06f51" alt="spicedb Logo">
7-
</a>
8-
</h1>
1+
# SpiceDB for Visual Studio Code
2+
<a href="https://marketplace.visualstudio.com/items?itemName=authzed.spicedb-vscode"><img src="https://img.shields.io/visual-studio-marketplace/v/authzed.spicedb-vscode?style=flat-square" alt="Visual Studio Marketplace"></a>
3+
<a href="https://discord.gg/spicedb"><img alt="discord badge" src="https://img.shields.io/badge/discord-spicedb-7289da?style=flat-square"></a>
4+
<a href="https://twitter.com/authzed"><img alt="twitter badge" src="https://img.shields.io/badge/twitter-@authzed-1d9bf0.svg?style=flat-square"></a>
5+
<a href="https://www.linkedin.com/company/authzed/"><img alt="linkedin badge" src="https://img.shields.io/badge/linkedin-+authzed-2D65BC.svg?style=flat-square"></a>
96

10-
<h3 align="center">
11-
SpiceDB sets the standard for authorization that <i>scales</i>.
12-
<br/><br/>Scale with<br/>
13-
Traffic • Dev Velocity • Functionality • Geography
14-
</h3>
7+
Official VS Code extension providing syntax highlighting, semantic information, and additional UI components for working with [SpiceDB] [schema] and [relationships data].
158

16-
<p align="center">
17-
<a href="https://discord.gg/spicedb"><img alt="discord badge" src="https://img.shields.io/discord/844600078504951838?color=7289da&label=discord&style=flat-square"></a>
18-
&nbsp;
19-
<a href="https://twitter.com/authzed"><img alt="twitter badge" src="https://img.shields.io/badge/twitter-@authzed-1d9bf0.svg?style=flat-square"></a>
20-
&nbsp;
21-
<a href="https://www.linkedin.com/company/authzed/"><img alt="linkedin badge" src="https://img.shields.io/badge/linkedin-+authzed-2D65BC.svg?style=flat-square"></a>
22-
</p>
23-
24-
# SpiceDB Extension for VS Code
25-
26-
VS Code extension that provides syntax highlighting, semantic information and addition UI for working with [SpiceDB] [schema] and [relationships data].
27-
28-
Brings [SpiceDB Playground] functionality into VS Code.
9+
This extension brings the [SpiceDB Playground] experience natively to VS Code.
2910

3011
[SpiceDB]: https://spicedb.io
3112
[schema]: https://authzed.com/docs/spicedb/concepts/schema
3213
[relationships data]: https://authzed.com/docs/spicedb/concepts/relationships
3314
[SpiceDB Playground]: https://play.authzed.com
3415

35-
<p align="center">
36-
<a href="https://marketplace.visualstudio.com/items?itemName=authzed.spicedb-vscode"><img src="https://img.shields.io/visual-studio-marketplace/v/authzed.spicedb-vscode" alt="Visual Studio Marketplace"></a>
37-
<a href="https://github.com/authzed/spicedb-vscode/releases"><img src="https://img.shields.io/github/v/release/authzed/spicedb-vscode?sort=semver&amp;color=green" alt="Release"></a>
38-
<a href="https://github.com/authzed/spicedb-vscode/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="License"></a>
39-
</p>
40-
41-
## What is SpiceDB?
42-
43-
SpiceDB is a graph database purpose-built for storing and evaluating access control data.
44-
45-
As of 2021, [broken access control became the #1 threat to the web][owasp]. With SpiceDB, developers finally have the solution to stopping this threat the same way as the hyperscalers.
46-
47-
[owasp]: https://owasp.org/Top10/A01_2021-Broken_Access_Control/
48-
49-
### Why SpiceDB?
50-
51-
- [**World-class engineering**][about]: painstakingly built by experts that pioneered the cloud-native ecosystem
52-
- [**Authentic design**][zanzibar]: mature and feature-complete implementation of Google's Zanzibar paper
53-
- [**Proven in production**][1M]: 5ms p95 when scaled to millions of queries/s, billions of relationships
54-
- [**Global consistency**][consistency]: consistency configured per-request unlocks correctness while maintaining performance
55-
- [**Multi-paradigm**][caveats]: caveated relationships combine the best concepts in authorization: ABAC & ReBAC
56-
- [**Safety in tooling**][tooling]: designs schemas with real-time validation or validate in your CI/CD workflow
57-
- [**Reverse Indexes**][reverse-indexes]: queries for "What can `subject` do?", "Who can access `resource`?"
58-
59-
[about]: https://authzed.com/why-authzed
60-
[zanzibar]: https://authzed.com/zanzibar
61-
[1M]: https://authzed.com/blog/google-scale-authorization
62-
[caveats]: https://netflixtechblog.com/abac-on-spicedb-enabling-netflixs-complex-identity-types-c118f374fa89
63-
[tooling]: https://authzed.com/docs/spicedb/modeling/validation-testing-debugging
64-
[reverse-indexes]: https://authzed.com/docs/spicedb/getting-started/faq#what-is-a-reverse-index
65-
[consistency]: https://authzed.com/docs/spicedb/concepts/consistency
66-
6716
## Installation
6817

6918
The SpiceDB VS Code Extension can be installed from the [VS Code Extension Marketplace].
@@ -76,7 +25,7 @@ The SpiceDB VS Code Extension can be installed from the [VS Code Extension Marke
7625

7726
<img src="assets/semantic-highlighting.gif" height="450">
7827

79-
### Real time validation and diagnotics
28+
### Real time validation and diagnostics
8029

8130
<img src="assets/errors.gif" height="450">
8231

0 commit comments

Comments
 (0)