Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 32 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,26 @@

## 📑 Table of Contents

- [🗺 Roadmap](#-roadmap)
- [🌟 Why UltimateAuth](#-why-ultimateauth)
- [🚀 Quick Start](#-quick-start)
- [💡 Usage](#-usage)
- [📘 Documentation](#-documentation)
- [🤝 Contributing](#-contributing)
- [⭐ Acknowledgements](#-acknowledgements)
## Table of Contents


## Table of Contents

- [Roadmap](#roadmap)
- [Why UltimateAuth](#why-ultimateauth)
- [Quick Start](#quick-start)
- [Usage](#usage)
- [Documentation](#documentation)
- [Upgrading & Breaking Changes](#upgrading--breaking-changes)
- [Community & Contributing](#community--contributing)
- [Acknowledgements](#acknowledgements)

---

UltimateAuth is an open-source auth framework with platform-level capabilities that unifies secure session, cookie and token based Auth, modern PKCE flows, Blazor/Maui-ready client experiences - eliminating the complexity of traditional Auth systems while providing a clean, lightweight, extensible and developer-first architecture.

---
## 🗺 Roadmap
## Roadmap

| Phase | Version | Scope | Status | Release Date |
| ----------------------- | ------------- | ----------------------------------------- | -------------- | ------------ |
Expand Down Expand Up @@ -67,7 +73,7 @@ Whether you're using UltimateAuth, exploring the project, or interested in contr

---

## 🌟 Why UltimateAuth
## Why UltimateAuth
The Six-Point Principles

### 1) Unified Authentication System
Expand Down Expand Up @@ -124,7 +130,7 @@ Traditional auth solutions struggle here — UltimateAuth embraces it.

---

# 🚀 Quick Start
# Quick Start
> ⏱ Get started in minutes
>
> **This Quick Start uses a Blazor Server application with in-memory persistence.**
Expand Down Expand Up @@ -251,7 +257,7 @@ For a **complete, step-by-step setup with all required configuration, components

---

## 💡 Usage
## Usage

**One Client. Your Auth Application API.**

Expand Down Expand Up @@ -324,7 +330,7 @@ Start with the simple API. Drop down to UltimateAuth's extensibility points when

---

## 📘 Documentation
## Documentation

Two documentation experiences are provided:

Expand All @@ -336,7 +342,19 @@ Create accounts, simulate devices, test auth flows, and observe UltimateAuth in

---

## 🤝 Community & Contributing
## Upgrading & Breaking Changes

UltimateAuth aims to keep upgrades straightforward. When a release introduces breaking changes, we provide concise migration guides explaining what needs to be updated.

**Upgrading from an earlier version?**

Check the [Migration Guides](https://ultimateauth.com/docs/migration/index) for version-specific instructions.

For new features and improvements, see the [GitHub Releases](https://github.com/CodeBeamOrg/UltimateAuth/releases).

---

## Community & Contributing

UltimateAuth is built by developers, for developers — and everyone is welcome to be part of its journey.

Expand All @@ -354,7 +372,7 @@ Every great open-source project starts with people willing to build something to

---

## ⭐ Acknowledgements
## Acknowledgements

UltimateAuth is built with love by CodeBeam and shaped by real-world .NET development —
for teams who want authentication to be secure, predictable, extensible, and a joy to use.
Expand Down
4 changes: 3 additions & 1 deletion docs/content/_groups.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,7 @@
"plugin-domains": 5,
"client": 6,
"configuration": 7,
"security": 8
"security": 8,
"how-to-guides": 9,
"migration": 10
}
13 changes: 13 additions & 0 deletions docs/content/how-to-guides/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: How-to Guides
order: 1
group: how-to-guides
---

# How-to Guides

Practical, task-oriented guides for building applications with UltimateAuth.

## Available Guides

- [Protect a Page](/docs/how-to-guides/protect-a-page) — Secure Blazor pages and UI sections using UltimateAuth and ASP.NET Core authorization.
Loading
Loading