mirror of
https://github.com/versia-pub/api.git
synced 2025-12-06 08:28:19 +01:00
docs(docs): 📝 Update READMEs
This commit is contained in:
Jesse Wierzbinski
parent
664568af38
commit
0d53c450f8
50
README.md
50
README.md
|
|
@ -8,13 +8,59 @@ Set of NPM packages written in TypeScript to interact with Lysand-compatible ser
|
|||
|
||||
## Packages
|
||||
|
||||
- **`@lysand-org/federation`**: Federation types and validators for Lysand server implementations.
|
||||
- **`@lysand-org/federation`**: Federation types, validators and cryptography for Lysand server implementations.
|
||||
- **`@lysand-org/client`**: Client for the reference Lysand Server implementation.
|
||||
|
||||
## Efficiency
|
||||
|
||||
The built output of each package is not even `200 KB` in size, making it a lightweight and efficient solution for your Lysand needs. Installing the package adds around `5 MB` to your `node_modules` folder, but this does not affect the final bundle size.
|
||||
|
||||
Compilation (bundling/minifying) time is a few seconds, almost all of which is spent on type-checking. The actual compilation time is less than a tenth of a second.
|
||||
|
||||
## Usage
|
||||
|
||||
### Federation
|
||||
|
||||
#### Roadmap
|
||||
|
||||
- [x] Zod objects
|
||||
- [ ] Signing code
|
||||
- [ ] Advanced validator
|
||||
|
||||
#### Validation
|
||||
|
||||
[**Zod**](https://zod.dev) is used to validate and parse the objects. All Lysand objects are already written for you.
|
||||
|
||||
You may use the `InferType<T>` export to get a direct type from the object.
|
||||
|
||||
```typescript
|
||||
// Note is a Zod object
|
||||
import { Note, type InferType } from "@lysand-org/federation";
|
||||
|
||||
const badObject = {
|
||||
IamBad: "Note",
|
||||
};
|
||||
|
||||
// Will throw an error
|
||||
const parsed = await Note.parseAsync(badObject);
|
||||
|
||||
// Infer the TypeScript type from the object
|
||||
type NoteType = InferType<typeof Note>;
|
||||
```
|
||||
|
||||
For more information about Note's methods, see the [**Zod documentation**](https://zod.dev/docs/).
|
||||
|
||||
Your editor's IntelliSense should provide you with every method and property available, which all match the [**Lysand**](https://lysand.org) specification names.
|
||||
|
||||
### Client
|
||||
|
||||
#### Roadmap
|
||||
|
||||
- [ ] Parity with [**megalodon**](https://github.com/h3poteto/megalodon)'s Mastodon client
|
||||
- [ ] Lysand-specific features
|
||||
|
||||
> [!WARNING]
|
||||
> These packages are not even published on NPM yet. They are still in development and are not ready for production use.
|
||||
> Not yet published or started work on.
|
||||
|
||||
## Getting Started
|
||||
|
||||
|
|
|
|||
128
federation/README.md
Normal file
128
federation/README.md
Normal file
|
|
@ -0,0 +1,128 @@
|
|||
<p align="center">
|
||||
<a href="https://lysand.org"><img src="https://cdn.lysand.org/logo-long-dark.webp" alt="Lysand Logo" height="110"></a>
|
||||
</p>
|
||||
|
||||
<center><h1><code>@lysand-org/federation</code></h1></center>
|
||||
|
||||
Federation types, validators and cryptography for Lysand server implementations.
|
||||
|
||||
## Efficiency
|
||||
|
||||
The built output of the package is not even `200 KB` in size, making it a lightweight and efficient solution for your Lysand needs. Installing the package adds around `5 MB` to your `node_modules` folder, but this does not affect the final bundle size.
|
||||
|
||||
Compilation (bundling/minifying) time is a few seconds, almost all of which is spent on type-checking. The actual compilation time is less than a tenth of a second.
|
||||
|
||||
## Usage
|
||||
|
||||
### Federation
|
||||
|
||||
#### Roadmap
|
||||
|
||||
- [x] Zod objects
|
||||
- [ ] Signing code
|
||||
- [ ] Advanced validator
|
||||
|
||||
#### Validation
|
||||
|
||||
[**Zod**](https://zod.dev) is used to validate and parse the objects. All Lysand objects are already written for you.
|
||||
|
||||
You may use the `InferType<T>` export to get a direct type from the object.
|
||||
|
||||
```typescript
|
||||
// Note is a Zod object
|
||||
import { Note, type InferType } from "@lysand-org/federation";
|
||||
|
||||
const badObject = {
|
||||
IamBad: "Note",
|
||||
};
|
||||
|
||||
// Will throw an error
|
||||
const parsed = await Note.parseAsync(badObject);
|
||||
|
||||
// Infer the TypeScript type from the object
|
||||
type NoteType = InferType<typeof Note>;
|
||||
```
|
||||
|
||||
For more information about Note's methods, see the [**Zod documentation**](https://zod.dev/docs/).
|
||||
|
||||
Your editor's IntelliSense should provide you with every method and property available, which all match the [**Lysand**](https://lysand.org) specification names.
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
#### For Usage
|
||||
|
||||
See the [**Compatibility**](#compatibility) section for the supported environments. Any package manager can be used to install the packages.
|
||||
|
||||
#### For Development
|
||||
|
||||
- [**Bun**](https://bun.sh) version `1.1.8` or higher.
|
||||
- Either the [**Linux**](https://www.linux.org) or [**macOS**](https://www.apple.com/macos) operating systems. ([**Windows**](https://www.microsoft.com/windows) will work, but is not officially supported.)
|
||||
|
||||
### Compatibility
|
||||
|
||||
This library is built for JavaScript runtimes with the support for:
|
||||
|
||||
- [**ES Modules**](https://nodejs.org/api/esm.html)
|
||||
- [**ECMAScript 2020**](https://www.ecma-international.org/ecma-262/11.0/index.html)
|
||||
|
||||
#### Runtimes
|
||||
|
||||
- **Node.js**: 14.0+ is the minimum, but only Node.js 20.0+ (LTS) is officially supported.
|
||||
- **Deno**: Support is unknown. 1.0+ is expected to work.
|
||||
- **Bun**: Bun 1.1.8 is the minimum-supported version. As Bun is rapidly evolving, this may change. Previous versions may also work.
|
||||
|
||||
#### Browsers
|
||||
|
||||
Consequently, this library is compatible without any bundling in the following browser versions:
|
||||
|
||||
- **Chrome**: 80+
|
||||
- **Edge**: 80+
|
||||
- **Firefox**: 74+
|
||||
- **Safari**: 13.1+
|
||||
- **Opera**: 67+
|
||||
- **Internet Explorer**: None
|
||||
|
||||
If you are targeting older browsers, please don't, you are doing yourself a disservice.
|
||||
|
||||
Transpilation to non-ES Module environments is not officially supported, but should be simple with the use of a bundler like [**Parcel**](https://parceljs.org) or [**Rollup**](https://rollupjs.org).
|
||||
|
||||
### Installation
|
||||
|
||||
Package is distributed as a scoped package on the NPM registry.
|
||||
|
||||
```bash
|
||||
npm install @lysand-org/federation # For NPM
|
||||
yarn add @lysand-org/federation # For Yarn
|
||||
pnpm add @lysand-org/federation # For PNPM
|
||||
bun add @lysand-org/federation # For Bun
|
||||
```
|
||||
|
||||
#### From Source
|
||||
|
||||
If you want to install from source, you can clone [this repository](https://github.com/lysand-org/api) and run the following commands:
|
||||
|
||||
```bash
|
||||
bun install # Install dependencies
|
||||
|
||||
bun run build # Build the packages
|
||||
```
|
||||
|
||||
The built package will be in the `federation/dist` folder.
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
### Projects
|
||||
|
||||
- [**Bun**](https://bun.sh): Thanks to the Bun team for creating an amazing JavaScript runtime.
|
||||
- [**TypeScript**](https://www.typescriptlang.org): TypeScript is the backbone of this project.
|
||||
- [**Node.js**](https://nodejs.org): Node.js created the idea of JavaScript on the server.
|
||||
|
||||
### People
|
||||
|
||||
- [**April John**](https://github.com/cutestnekoaqua): Creator and maintainer of the Lysand Server ActivityPub bridge.
|
||||
Loading…
Reference in a new issue