Skip to content

Commit

Permalink
Update some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cmackenzie1 committed Feb 7, 2025
1 parent abc4d4e commit 449e182
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 10 deletions.
30 changes: 20 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,40 @@

![Torii Logo](./assets/splash.jpeg)

> ⚠️ **Warning**: This project is in early development and is not stable. The API is subject to change without notice.
> [!WARNING]
> This project is in early development and is not production-ready. The API is subject to change without notice.
## Overview

Torii is currently under active development. As we are in the initial phases, many features are experimental and may be significantly modified or removed in future versions.

The goal of Torii is to provide a simple and flexible authentication system for web applications through plugins.
Torii is a flexible authentication framework for Rust applications that provides a plugin-based system for multiple authentication methods. It's designed to be simple to use while remaining extensible for various authentication needs.

## Development Status

- 🚧 Early Development
- ⚠️ Not Production Ready
- 📝 APIs Subject to Change

## Features

- 🔐 Multiple authentication methods
- Email/Password authentication
- OpenID Connect (OIDC)
- WebAuthn (Coming Soon)
- 💾 Storage backends
- SQLite support
- Postgres support (#3)
- MySQL support (#4)
- 🔌 Plugin system for extending functionality

## Current Plugins

- [Password Auth](./torii-auth-email/README.md)
- OAuth 2.0 Auth (coming soon)
- OpenID Connect Auth (coming soon)
- WebAuthn Auth (coming soon)
- [Email/Password Authentication](./torii-auth-email/README.md)
- [OpenID Connect (OIDC)](./torii-auth-oidc/README.md)

## Disclaimer
## Security

This project is not production ready and should not be used in production environments. The maintainers are not responsible for any data loss or other issues that may arise from using this software.
> [!IMPORTANT]
> As this project is in early development, it has not undergone security audits and should not be used in production environments. The maintainers are not responsible for any security issues that may arise from using this software.
## Contributing

Expand Down
23 changes: 23 additions & 0 deletions torii/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,26 @@
//! Torii - A flexible authentication framework for Rust
//!
//! Torii provides a pluggable authentication system that supports multiple
//! authentication methods and storage backends.
//!
//! # Example
//!
//! ```rust,no_run
//! use torii::{Torii, ToriiBuilder};
//! use torii_auth_email::EmailAuthPlugin;
//! use torii_storage_sqlite::SqliteStorage;
//!
//! # async fn example() -> Result<(), Box<dyn std::error::Error>> {
//! let storage = SqliteStorage::new("torii.db").await?;
//!
//! let torii = ToriiBuilder::new(storage, storage)
//! .with_email_auth()
//! .setup_sqlite()
//! .await?;
//! # Ok(())
//! # }
//! ```
use std::sync::Arc;

use sqlx::Pool;
Expand Down

0 comments on commit 449e182

Please sign in to comment.