Skip to content

Commit

Permalink
fix: docs and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
singhhp1069 committed Jan 5, 2024
1 parent 44d47f3 commit 48936f4
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Authonomy Project

## Introduction

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.

## Features

- **Decoupled Authentication and Authorization**: Leverage popular authentication methods while managing authorization independently.
- **DID-Based Authorization**: Implement flexible and secure authorization using Decentralized Identifiers.
- **Verifiable Credentials**: Utilize Verifiable Credentials (VCs) and Verifiable Presentations (VPs) for robust access control.

## Getting Started

### Prerequisites

- Docker and Docker-compose

### Installation

#### Using Docker-Compose

```sh
git clone https://github.com/singhhp1069/authonomy.git
cd authonomy
docker-compose up --build
```

## Documentation

Visit our GitHub Pages for detailed documentation.
Check out docs/markdown for markdown documentation.

## Contributing

We welcome contributions to Authonomy! Please read our Contributing Guidelines for more information on how to get involved.

## License
25 changes: 25 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
title: Authonomy
description: >-
Revolutionizing Authorization Management for Developers.
baseurl: "/authonomy"
url: "https://singhhp1069.github.io"

# Build settings
markdown: kramdown
theme: minima
plugins:
- jekyll-feed

# Exclude from production build
exclude:
- Gemfile
- Gemfile.lock
- node_modules
- vendor
- .jekyll-cache
- .sass-cache

collections:
markdown:
output: true
permalink: /:collection/:path/

0 comments on commit 48936f4

Please sign in to comment.