diff --git a/.github/assets/tsky-logo.png b/.github/assets/tsky-logo.png new file mode 100644 index 0000000..5b00942 Binary files /dev/null and b/.github/assets/tsky-logo.png differ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b7da0e0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# Contributing + +TODO: Add contributing guidelines \ No newline at end of file diff --git a/README.md b/README.md index 0c85fad..ff85def 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,62 @@ -# TSky +
+
+
+ A lightweight, fast, universal and typed Bluesky API wrapper for Apps & Bots. +
+ +## ⚠️ TSky is still in development and is not ready for production use. + +TSksy is still in active development and is not ready for production use. If you want to contribute to the project, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file or join our [Discord Server](https://discord.gg/KPD7XPUZn3). + +TSky is a lightweight, fast, universal and typed Bluesky API wrapper for Apps & Bots. It's designed to be easy to use, lightweight and straightforward to use. It's built with TypeScript and has full type support. + +It was primarily built for the [Nimbus Client](https://github.com/nimbus-town/nimbus) but can be used in any other project that requires Bluesky API integration. + +## Installation + +```bash +# NPM +npm install tsky + +# Yarn +yarn add tsky + +# PNPM +pnpm add tsky + +# Bun +bun add tsky +``` + +## Usage + +```ts +import { Tsky } from 'tsky' + + +const app = new AppBskyNS(); // TODO +const tsky = new Tsky(app); + +const profile = await tsky.profile('did:plc:giohuovwawlijq7jkuysq5dd'); + +console.log(profile.handle); +``` + +## Links + +- [📚 TSky Documentation](#) (TODO: add docs link) +- [🦋 TSky on Bluesky](https://bsky.app/profile/tsky.dev) +- [📣 TSky Discord Server](https://discord.gg/KPD7XPUZn3) +- [🦋 Nimbus on Bluesky](https://bsky.app/profile/nimbus.town) + +## Contributing + +If you want to contribute to this project, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file. + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. \ No newline at end of file