Skip to content

Commit a8e85d2

Browse files
committed
docs: update the README.md and add placeholder for contribution guidelines
1 parent 8d68839 commit a8e85d2

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+
<h1 align="center">TSky</h1>
22

3-
A BlueSky API Wrapper
3+
<p align="center">
4+
<img src=".github/assets/tsky-logo.png" width="200" height="200">
5+
</p>
6+
7+
<p align="center">
8+
A lightweight, fast, universal and typed Bluesky API wrapper for Apps & Bots.
9+
</p>
10+
11+
---
12+
13+
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.
14+
15+
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.
16+
17+
## Installation
18+
19+
```bash
20+
# NPM
21+
npm install tsky
22+
23+
# Yarn
24+
yarn add tsky
25+
26+
# PNPM
27+
pnpm add tsky
28+
29+
# Bun
30+
bun add tsky
31+
```
32+
33+
## Usage
34+
35+
```ts
36+
import { Tsky } from 'tsky'
37+
38+
39+
const app = new AppBskyNS(); // TODO
40+
const tsky = new Tsky(app);
41+
42+
const profile = await tsky.profile('did:plc:giohuovwawlijq7jkuysq5dd');
43+
44+
console.log(profile.handle);
45+
```
46+
47+
## Documentation
48+
49+
You can find the documentation (TODO: Add link to TSky docs)
50+
51+
## Links
52+
53+
- [📚 TSky Documentation](#)
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)