Skip to content

Commit 48936f4

Browse files
committed
fix: docs and readme
1 parent 44d47f3 commit 48936f4

2 files changed

Lines changed: 63 additions & 0 deletions

File tree

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Authonomy Project
2+
3+
## Introduction
4+
5+
Authonomy is an innovative middleware designed to revolutionize authorization management for application developers. This solution decouples authentication from authorization, enabling the use of decentralized authorization mechanisms through DIDs, VCs, and VPs.
6+
7+
## Features
8+
9+
- **Decoupled Authentication and Authorization**: Leverage popular authentication methods while managing authorization independently.
10+
- **DID-Based Authorization**: Implement flexible and secure authorization using Decentralized Identifiers.
11+
- **Verifiable Credentials**: Utilize Verifiable Credentials (VCs) and Verifiable Presentations (VPs) for robust access control.
12+
13+
## Getting Started
14+
15+
### Prerequisites
16+
17+
- Docker and Docker-compose
18+
19+
### Installation
20+
21+
#### Using Docker-Compose
22+
23+
```sh
24+
git clone https://github.com/singhhp1069/authonomy.git
25+
cd authonomy
26+
docker-compose up --build
27+
```
28+
29+
## Documentation
30+
31+
Visit our GitHub Pages for detailed documentation.
32+
Check out docs/markdown for markdown documentation.
33+
34+
## Contributing
35+
36+
We welcome contributions to Authonomy! Please read our Contributing Guidelines for more information on how to get involved.
37+
38+
## License

docs/_config.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
title: Authonomy
2+
description: >-
3+
Revolutionizing Authorization Management for Developers.
4+
baseurl: "/authonomy"
5+
url: "https://singhhp1069.github.io"
6+
7+
# Build settings
8+
markdown: kramdown
9+
theme: minima
10+
plugins:
11+
- jekyll-feed
12+
13+
# Exclude from production build
14+
exclude:
15+
- Gemfile
16+
- Gemfile.lock
17+
- node_modules
18+
- vendor
19+
- .jekyll-cache
20+
- .sass-cache
21+
22+
collections:
23+
markdown:
24+
output: true
25+
permalink: /:collection/:path/

0 commit comments

Comments
 (0)