Skip to content

Commit fc03392

Browse files
authored
docs: update the README.md (#20)
1 parent 9e3ba8d commit fc03392

3 files changed

Lines changed: 64 additions & 2 deletions

File tree

.github/assets/tsky-logo.png

5.31 KB
Loading

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Contributing
2+
3+
TODO: Add contributing guidelines

README.md

Lines changed: 61 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,62 @@
1-
# TSky
1+
<p align="center">
2+
<img src=".github/assets/tsky-logo.png" width="200" height="200">
3+
</p>
24

3-
A BlueSky API Wrapper
5+
<h1 align="center">TSky</h1>
6+
7+
<p align="center">
8+
A lightweight, fast, universal and typed Bluesky API wrapper for Apps & Bots.
9+
</p>
10+
11+
## ⚠️ TSky is still in development and is not ready for production use.
12+
13+
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).
14+
15+
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.
16+
17+
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.
18+
19+
## Installation
20+
21+
```bash
22+
# NPM
23+
npm install tsky
24+
25+
# Yarn
26+
yarn add tsky
27+
28+
# PNPM
29+
pnpm add tsky
30+
31+
# Bun
32+
bun add tsky
33+
```
34+
35+
## Usage
36+
37+
```ts
38+
import { Tsky } from 'tsky'
39+
40+
41+
const app = new AppBskyNS(); // TODO
42+
const tsky = new Tsky(app);
43+
44+
const profile = await tsky.profile('did:plc:giohuovwawlijq7jkuysq5dd');
45+
46+
console.log(profile.handle);
47+
```
48+
49+
## Links
50+
51+
- [📚 TSky Documentation](#) (TODO: add docs link)
52+
- [🦋 TSky on Bluesky](https://bsky.app/profile/tsky.dev)
53+
- [📣 TSky Discord Server](https://discord.gg/KPD7XPUZn3)
54+
- [🦋 Nimbus on Bluesky](https://bsky.app/profile/nimbus.town)
55+
56+
## Contributing
57+
58+
If you want to contribute to this project, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
59+
60+
## License
61+
62+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)