Skip to content

Commit

Permalink
update links
Browse files Browse the repository at this point in the history
  • Loading branch information
pilcrowonpaper committed Jan 27, 2024
1 parent be00160 commit a8043c9
Show file tree
Hide file tree
Showing 15 changed files with 51 additions and 41 deletions.
40 changes: 13 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,23 @@
# Lucia

Lucia is a simple and flexible user and session management library that provides an
abstraction layer between your app and your database. It's bare-bones by design, keeping
everything easy to use and understand.
Lucia is an auth library written in TypeScript that abstracts away the complexity of handling sessions. It works alongside your database to provide an API that's easy to use, understand, and extend.

### Code sample

Working with Lucia looks something like this. In the code below, you're creating a new user with an email/password method, creating a new session, and creating a cookie that you can set to the user.
- No more endless configuration and callbacks
- Fully typed
- Works in any runtime - Node.js, Bun, Deno, Cloudflare Workers
- Extensive database support out of the box

```ts
const user = await auth.createUser({
key: {
providerId: "email",
providerUserId: email,
password
},
attributes: {
email
}
});
const session = await auth.createSession({
userId: user.userId,
attributes: {}
});
const sessionCookie = auth.createSessionCookie(session);
import { Lucia } from "lucia";

const lucia = new Lucia(new Adapter(db));

const session = await lucia.createSession(userId, {});
await lucia.validateSession(session.id);
```

Lucia is an open source library released under the MIT license, with the help of [100+ contributors](https://github.com/lucia-auth/lucia/graphs/contributors)!

## Resources

**[Documentation](https://lucia-auth.com)**
Expand All @@ -45,9 +37,3 @@ npm i lucia
pnpm add lucia
yarn add lucia
```

## Attributions

This project would not have been possible without our contributors, thank you!

Logo by [@dawidmachon](https://github.com/dawidmachon), licensed under [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/).
4 changes: 2 additions & 2 deletions packages/adapter-drizzle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

[Drizzle ORM](https://orm.drizzle.team) adapter for Lucia.

**[Documentation](https://lucia-auth.com/database/drizzle)**
**[Documentation](https://v3.lucia-auth.com/database/drizzle)**

**[Lucia documentation](https://lucia-auth.com)**
**[Lucia documentation](https://v3.lucia-auth.com)**

**[Changelog](https://github.com/pilcrowOnPaper/lucia/blob/main/packages/adapter-drizzle/CHANGELOG.md)**

Expand Down
4 changes: 2 additions & 2 deletions packages/adapter-mongodb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

[MongoDB](https://mongodb.com) adapter for Lucia. Can also be used with [Mongoose](https://github.com/Automattic/mongoose).

**[Documentation](https://lucia-auth.com/database/mongodb)**
**[Documentation](https://v3.lucia-auth.com/database/mongodb)**

**[Lucia documentation](https://lucia-auth.com)**
**[Lucia documentation](https://v3.lucia-auth.com)**

**[Changelog](https://github.com/pilcrowOnPaper/lucia/blob/main/packages/adapter-mongodb/CHANGELOG.md)**

Expand Down
4 changes: 4 additions & 0 deletions packages/adapter-mysql/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# @lucia-auth/adapter-mysql

## 3.0.0

See the [migration guide](https://v3.lucia-auth.com/upgrade-v3/mysql).

## 2.1.0

### Minor changes
Expand Down
4 changes: 2 additions & 2 deletions packages/adapter-mysql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

MySQL adapter for Lucia.

**[Documentation](https://lucia-auth.com/database/mysql#schema)**
**[Documentation](https://v3.lucia-auth.com/database/mysql#schema)**

**[Lucia documentation](https://lucia-auth.com)**
**[Lucia documentation](https://v3.lucia-auth.com)**

**[Changelog](https://github.com/pilcrowOnPaper/lucia/blob/main/packages/adapter-mysql/CHANGELOG.md)**

Expand Down
4 changes: 4 additions & 0 deletions packages/adapter-postgresql/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# @lucia-auth/adapter-postgresql

## 3.0.0

See the [migration guide](https://v3.lucia-auth.com/upgrade-v3/postgresql).

## 2.0.2

### Patch changes
Expand Down
4 changes: 2 additions & 2 deletions packages/adapter-postgresql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

PostgreSQL adapter for Lucia.

**[Documentation](https://lucia-auth.com/database/postgresql)**
**[Documentation](https://v3.lucia-auth.com/database/postgresql)**

**[Lucia documentation](https://lucia-auth.com)**
**[Lucia documentation](https://v3.lucia-auth.com)**

**[Changelog](https://github.com/pilcrowOnPaper/lucia/blob/main/packages/adapter-postgresql/CHANGELOG.md)**

Expand Down
4 changes: 4 additions & 0 deletions packages/adapter-prisma/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# @lucia-auth/adapter-prisma

## 4.0.0

See the [migration guide](https://v3.lucia-auth.com/upgrade-v3/prisma).

## 3.0.2

### Patch changes
Expand Down
4 changes: 2 additions & 2 deletions packages/adapter-prisma/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

[Prisma](https://www.prisma.io) adapter for Lucia.

**[Documentation](https://lucia-auth.com/database/prisma)**
**[Documentation](https://v3.lucia-auth.com/database/prisma)**

**[Lucia documentation](https://lucia-auth.com)**
**[Lucia documentation](https://v3.lucia-auth.com)**

**[Changelog](https://github.com/pilcrowOnPaper/lucia/blob/main/packages/adapter-prisma/CHANGELOG.md)**

Expand Down
4 changes: 4 additions & 0 deletions packages/adapter-sqlite/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# @lucia-auth/adapter-sqlite

## 3.0.0

See the [migration guide](https://v3.lucia-auth.com/upgrade-v3/sqlite).

## 2.0.1

### Patch changes
Expand Down
4 changes: 2 additions & 2 deletions packages/adapter-sqlite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

SQLite adapter for Lucia.

**[Documentation](https://lucia-auth.com/database/sqlite)**
**[Documentation](https://v3.lucia-auth.com/database/sqlite)**

**[Lucia documentation](https://lucia-auth.com)**
**[Lucia documentation](https://v3.lucia-auth.com)**

**[Changelog](https://github.com/pilcrowOnPaper/lucia/blob/main/packages/adapter-sqlite/CHANGELOG.md)**

Expand Down
4 changes: 4 additions & 0 deletions packages/adapter-test/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# @lucia-auth/adapter-test

## 5.0.0

- Update API to support Lucia v3

## 4.1.1

### Patch changes
Expand Down
2 changes: 1 addition & 1 deletion packages/adapter-test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Testing module for Lucia database adapters.

**[Lucia documentation](https://lucia-auth.com)**
**[Lucia documentation](https://v3.lucia-auth.com)**

**[Changelog](https://github.com/pilcrowOnPaper/lucia/blob/main/packages/adapter-test/CHANGELOG.md)**

Expand Down
4 changes: 4 additions & 0 deletions packages/lucia/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# lucia

## 3.0.0

See the [migration guide](https://v3.lucia-auth.com/upgrade-v3).

## 2.7.6

### Patch changes
Expand Down
2 changes: 1 addition & 1 deletion packages/lucia/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

An open source auth library that abstracts away the complexity of handling sessions. It works alongside your database to provide an API that's easy to use, understand, and extend.

**[Documentation](https://lucia-auth.com)**
**[Documentation](https://v3.lucia-auth.com)**

**[Changelog](https://github.com/pilcrowOnPaper/lucia/blob/main/packages/lucia/CHANGELOG.md)**

Expand Down

0 comments on commit a8043c9

Please sign in to comment.