Skip to content

Commit b68781c

Browse files
Copilotnomeguy
andcommitted
docs: enhance README with table of contents and why section
- Add table of contents for easier navigation - Add "Why Casbin?" section highlighting key benefits - Add "How to Contribute" section with emoji icons - Improve overall structure for 1.0.0 production readiness Co-authored-by: nomeguy <85475922+nomeguy@users.noreply.github.com>
1 parent 9b3753e commit b68781c

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,30 @@ An authorization library that supports access control models like ACL, RBAC, ABA
1111

1212
![casbin Logo](casbin-logo.png)
1313

14+
## Table of Contents
15+
16+
- [Why Casbin?](#why-casbin)
17+
- [Installation](#installation)
18+
- [Get Started](#get-started)
19+
- [Supported Models](#supported-models)
20+
- [How It Works](#how-it-works)
21+
- [Features](#features)
22+
- [Documentation](#documentation)
23+
- [Examples](#examples)
24+
- [Contributing](#how-to-contribute)
25+
- [License](#license)
26+
27+
## Why Casbin?
28+
29+
Casbin is a powerful and efficient open-source access control library. It provides support for enforcing authorization based on various access control models:
30+
31+
**Multiple Models**: Support for ACL, RBAC, ABAC, and more
32+
**Flexible & Scalable**: Easily customize your access control model
33+
**Production Ready**: Battle-tested across multiple languages and platforms
34+
**Policy Management**: Built-in APIs for managing permissions at runtime
35+
**Zero Dependencies**: Minimal footprint with no external runtime dependencies
36+
**Well Tested**: Comprehensive test coverage with 452+ test cases
37+
1438
## All the languages supported by Casbin:
1539

1640
| [![golang](https://casbin.org/img/langs/golang.png)](https://github.com/casbin/casbin) | [![java](https://casbin.org/img/langs/java.png)](https://github.com/casbin/jcasbin) | [![nodejs](https://casbin.org/img/langs/nodejs.png)](https://github.com/casbin/node-casbin) | [![php](https://casbin.org/img/langs/php.png)](https://github.com/php-casbin/php-casbin) |
@@ -221,6 +245,18 @@ Support this project by becoming a sponsor. Your logo will show up here with a l
221245
<a href="https://opencollective.com/casbin/sponsor/1/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/1/avatar.svg"></a>
222246
<a href="https://opencollective.com/casbin/sponsor/2/website" target="_blank"><img src="https://opencollective.com/casbin/sponsor/2/avatar.svg"></a>
223247

248+
## How to Contribute
249+
250+
Please read the [contributing guide](CONTRIBUTING.md) for details on our development process and how to submit pull requests.
251+
252+
We welcome contributions from the community! Whether it's:
253+
- 🐛 Bug fixes
254+
- ✨ New features
255+
- 📝 Documentation improvements
256+
- 🧪 Test improvements
257+
258+
All contributions are appreciated! Join our [Discord](https://discord.gg/S5UjpzGZjN) to discuss with the community.
259+
224260
## License
225261

226262
This project is licensed under the [Apache 2.0 license](LICENSE).

0 commit comments

Comments
 (0)