From 487053f8331eb4a8e4ebf4b89bc5b69751d4373e Mon Sep 17 00:00:00 2001 From: Bereket Engida Date: Thu, 26 Sep 2024 21:39:42 +0300 Subject: [PATCH] docs: general goals --- README.md | 8 ++++++++ docs/content/docs/introduction.mdx | 12 ++++++++++-- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f0a482369f..d939ff18e0 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,11 @@ Framework-agnostic, Comprehensive, extensible authentication library for TypeScr pnpm i better-auth ``` + +## Project Goals + +- **Prioritize Best Practices**: Focus on delivering best practices instead of extensive configuration options. +- **Framework Agnostic**: Aim to be framework-independent by using general solutions whenever possible, avoiding framework-specific dependencies as much as possible. +- **Comprehensive Offerings**: Provide a wide range of utilities to prevent reinventing the wheel for any authentication-related tasks. +- **Embrace Type Safety**: Value type-safety. Embrace typescript magic. +- **Universal Functionality**: Try to make the server side of better-auth as universal as possible. \ No newline at end of file diff --git a/docs/content/docs/introduction.mdx b/docs/content/docs/introduction.mdx index 1b067769b1..c18cae26f5 100644 --- a/docs/content/docs/introduction.mdx +++ b/docs/content/docs/introduction.mdx @@ -7,9 +7,16 @@ Better Auth is framework-agnostic authentication and authorization library for T ## Why Better Auth? -> Authentication feels like a partially solved problem, existing open-source libraries often require a lot of additional code for anything beyond a simple login. Third-party services, while convenient, force you to store user data on their servers, which in some ways strips you of ownership and it also comes with its own set of problems. And obviously, these services aren't free and can get really expensive. +> Authentication feels like a partially solved problem, existing open-source libraries often require a lot of additional code for anything beyond a simple login. Third-party services, while convenient, force you to store user data on their servers, which in some ways strips you of ownership and it also comes with its own set of problems. And obviously, these services aren't free and can get really expensive. +Better auth is born out of these frustrations. It aims to provides a comprehensive authentication library from the core accompanied by a growings plugin ecosystem, that allows you to add many auth related features in short amount of time. -> Better Auth offers a different approach. It provides a comprehensive authentication library from the core accompanied by a growings plugin ecosystem, that allows you to add many authentication related features in just minutes. Need multi-factor authentication? Simply use our 2FA plugin. Looking to support workspaces, organizations, member roles, or access control for you multi tenant apps? In minutes you'll have a fully featured auth system. +## General Goals + +- **Be Comprehensive**: The goal is to save users from reinventing the wheel for anything realted auth. +- **Prioritize Best Practices**: provide best practices rather than overwhelming users with configuration options. +- **Framework Agnostic**: The aim is to be friendly to all frameworks and try to avoid framework-specific solutions and features as much as possible. +- **Consistance**: Provide a consistent and predictable API. +- **Embrace Type Safety**: Value type-safety. Embrace typescript magic when necessary. ## Features @@ -18,3 +25,4 @@ Better auth is aims to be the most comprehensive auth library. It provides a wid and much more and even more to come... +