From a8e85d244c69b9a22832407ccf0e7cba3d753aed Mon Sep 17 00:00:00 2001 From: Dominik Biedebach Date: Sat, 30 Nov 2024 10:35:21 +0100 Subject: [PATCH 1/6] docs: update the README.md and add placeholder for contribution guidelines --- .github/assets/tsky-logo.png | Bin 0 -> 5439 bytes CONTRIBUTING.md | 3 ++ README.md | 63 +++++++++++++++++++++++++++++++++-- 3 files changed, 64 insertions(+), 2 deletions(-) create mode 100644 .github/assets/tsky-logo.png create mode 100644 CONTRIBUTING.md diff --git a/.github/assets/tsky-logo.png b/.github/assets/tsky-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..5b0094244892c2965100d47c82f28de6f49291d4 GIT binary patch literal 5439 zcmZvgWmr^Ex5sG-5rjcPngQuhkfC8fr3a812I(#V>F%K<29TDNaA=Sc>0xL@8dO3W zY3UH=g7D)Z~ZZBfIn>)Lt zL_ZD=4UvkHg06SgwoyO=W4FiN^b@bfN7=jXUKheM%3#(!yj1cH{D=I!xYU495>0dU z*Ds^7E)pi5S*mXdqRNO5#1BQo?WvAk}=;Mh!K$9AV@{*b1_K3n5xztoedY_1;j^2= zq+&nD1nIJ0u#lM%ZdkCDcYNvDB$2XZoY`VutJyaYEH)L#3E)Q8ibsa69GS_OtfJrLzA2ul)Rl-hJJ{2Jhye&M=leLpkb|{gqg;} z1=h_qptkru;oCX?B;l(T^vQHhliB~wp}diR-i{2ubwHbiEJRB_F1$JvFKUwd8=_}) zuT_xsbp)+p^~2y+L3HotDT}iDX1!)1oMxK{ z_%0MM`mPO|O2#`w9+ecD?lLznWG7h@xBCq)oVM>1{`;HpbXI=?&*L}qha~nZ*Zfei zzwAer!hGsMCz5+t>E0Es4WwK3an4=E3C{!gS72T+)M%=wf(LUzxj*{IrpjSB4{7x* z{d(JD{!-*;Ea#D5mCJnwGs4e>VK*UE&-X-sWF7{DxAqY0AZX~+N%45v8|n^!(EJE? zVQc;fj%%nR>scqaFBiS9g$&JbJfzXQ_$5o467>(Na8KMb(TvplwaKI48A#8_p1sMYtr@c_e8{IF{!~| z9;dVlZCi}*9Cb)w%{~Y@S$!?IUH{xhN*ZZ}z)H5KNfZ7|?kvBpG5=FFbNW%ZU7BER z0O4)TT^gJ)+{D9^b-iW;ut~FBX1w0aqG4uic2PSmc4{LMP9O&R*ErwpEo3F;>yVfG z-%`9SFx=Y=y{#|2#&NtOQtykR;myBXp&mLyQ-)Ib$R_bjHf6J(Jab_iA zc!VsVyqGeq*D5v<voh1*&ILTKBiy9BfMR)eJ=SH- zIpfV8rX`U;^B>eJ`5~1bL`|W>p}M?xKZr)+Vz~|uL6HdtvBD}x!AA$dl%K4|nA|%o zR#swZ-^8ej58*Cy-~s)8FXiJV3BX1!a%X4r^NxxpEe`&#L0RXA{s(hju-u@-v3%;m zoEITFU?wz=R>>pq;7nx@b%vbXUh?jWI%W2y{7gqU4vHLmKitJuTUKk|sWHS{8TqhP=PEH0&RYKGvc| z;V0t}V5v%m5H&zw7dDxZMPAPL+`m2xpr+WPr#Bgg^F}6(CLJ#H4zQjHSdw6QdKf<-p^+oj zO3Wh7=0i<^Ze+QOJ$!d^t}#7wmuuT)y)e4PiRd-1u8=!@%g%&Td=lfG1l<8^msvi| zjrXokWNNfEyLKHFLq-8P`o9VlKqb&v8B9Hzix}Fyru}Geu7L9b6F{BY?l!>|qQf>s zO%$UN>WW5_8i?}=g6M&{S*y=8v&Y^@UM=TUL)UMUg90DwD~V1K7waK`?c>H9fekDEE>uuoIZJl`^VXm z8d%gAj&dJ&mPO=zb~Ya&`ACEqGan^YS7ozmfNxZ|t>GUs&&j!LO|fb8OC7mKVC+e4 z9pIjhd{1~f@V!a|)aES$P%I$(+-A3J#d8lR+~Fa*kz{CNnt1Y3 zQm9@eyv4b9|GN*C#WDPRQukLxIXzAhJZ-wkIH3hA|YAvRP*~^r& zbJT7-@b6T*zdg{p66!c7{AO`+e1)#yIGz2>wcnXiTa+_Fu=Gaedf?2p$6vy(87=F@T4nA!ht|5uVp`bb{!vwkDPsKU0AXDHd()?Er?a#U*Dn6?mvy7Gg=M>H<^5wR%Q8N1vg@nGD%Ddy9fvToy{Nd0oB#{lj{6KT5yO6qn>VKw zWwZeCfjESxXgEYMrgzxuvgePN5G+Tog&=$qCgqpL_W}QFO zd*`fZ0VM2U4y#suTbe^EWlpw8{ms33d_)D)Jh$3rNx!ue^ZQ_c{QX>RyOsNC!{YG3 zS@yeCn*}(?wE-`l&vo$gfSaDmm85W7IL1E2lD8F;(w(i?%A^k6M135y(pRW{ z8tMc`Z%XF*+CSIXTejL^pp676&)C@-idq@JsfQXv^VmjK>;=0^e6ILNLsYQvpyo9)C_3nrVCD0=t6RYeQ4OyICo z1_=-s2!r({+rHI*ZAl!sd2#QX>9ZLxN4s&!J0K)*yH05>$|EDZMUO-C*Zon4(^Q3N zOxkI#vj77sJi*8yB56SN7)9UpI-=#Fx&@Hh&Qh+*D4*QYmhbIolJKX?DnquQt0gI^ z1;3pY<>p#|Ui|2Wn5q8hG961M#%ESNF~1_B%PREf4)Uu|MRi#3UG9pePreXMs8?n& zWBr$m4_AUl*C-W1PUePtxnkAh`vzDkiro%1XMsACNv{Q?2y-eLEBp(%{!dk>wmaZ& zLr_g)TL-_RezG#>oLBi1GQLj7E8z`X0mTny{@4lC>`9D^hCx{dXHJBYKDdt$JLuVV zQ#HKiD^4LkEs`&B`xVz9`qgd0gf(8#DD4aWoqJy!UQX(@%RE}Ew53Z&71ke-+t524 z)qJWidTfv4e+WPwUPPx%Lu_|R-s_uVj|c^QaAD`7K3K7e8AKD zuP!4-dml&ip%Dr}?4FS1FUPQ0%We=>| z3Fytd6w1mq!KD#W%@>4ff0RW7R4t{In=?I2t}O>k?JKR*6co?4(Ml3bs90z*tF4Gf zwCu_3!~_`DT5o6;bUj9RPcWrM5Dg&e-R&@Gm3DLC+0u;r&WWuF%9RwO5WUw!HIc*{ z6PjTx-qOAbkA#FD6J|0N8ad8;wwgKVKzE|7Q*RUu(Fxq7#@+*LjajuZM}t_AtL3|z zNxgk0E&hMdR3jta5`YO@524h4lQ!vhoX4jbO#{o{vV;6ICze6FyYKVro*p**Ve11; z$!BG^M+u>aVnOc}{keNxOTfmy4*8<;RX>w6MXe_vL4w@YMx{)HN|eQ5Nj+T&m}L zPZpZZ4m&vfUU*H6ZehX)7TR3@yrA{Y%gQR%g4B327PF<~9~n%)`?mLR!8mPZV<%%^ zfhFs*^Eau6Q+Kp^qDrKqRg%299h-k+(Go1Zc*-U=F_>|lreJvIXQX&MND+Vdug+@y zyTQnBzV~y@nWz(4cyu)zMkv0`edT^PcY0?zKtl0 zU`P;obW!*|Gz07>!lhWJoQ_TJPfJ6bA}Ab^wY1*8g>hz+muZI}LJbhn78!)bP^zLf z5*cYc1lLngZ%`pp40Ea;!jHRF10Zj2Orb3_sJZV(}8;6YvXkTZBsNbB>LwqybG4x+d4!TdkO zX(%(c8gJtEPx_{(V^(tm@UGO+KBjK;{}@-gwDVXm*vZ2toWaqKHg>pxM+uHgb;GEX z`4Kd~q;Fu9)_?F-C_CDkGJtq1Brxil;J>&^{$a6%+O0a3@{{YGSg)9I7 literal 0 HcmV?d00001 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..6341e46 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,62 @@ -# TSky +

TSky

-A BlueSky API Wrapper +

+ +

+ +

+ A lightweight, fast, universal and typed Bluesky API wrapper for Apps & Bots. +

+ +--- + +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); +``` + +## Documentation + +You can find the documentation (TODO: Add link to TSky docs) + +## Links + +- [📚 TSky Documentation](#) +- [🦋 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 From da5acc9b2bd17f11330b643d837c809ad92c16b9 Mon Sep 17 00:00:00 2001 From: Dominik Biedebach Date: Sat, 30 Nov 2024 10:36:36 +0100 Subject: [PATCH 2/6] docs: move headline below logo --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6341e46..9a79c46 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ -

TSky

-

+

TSky

+

A lightweight, fast, universal and typed Bluesky API wrapper for Apps & Bots.

From 693975354df8cac271f230c9d546ef0fb1c85467 Mon Sep 17 00:00:00 2001 From: Dominik Biedebach Date: Sat, 30 Nov 2024 10:37:09 +0100 Subject: [PATCH 3/6] docs: remove hr in README --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 9a79c46..7a66a9d 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,6 @@ A lightweight, fast, universal and typed Bluesky API wrapper for Apps & Bots.

---- - 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. From 970cfe075c4bf875e2b9bec670bff87427a1f4fb Mon Sep 17 00:00:00 2001 From: Dominik Biedebach Date: Sat, 30 Nov 2024 10:38:15 +0100 Subject: [PATCH 4/6] docs: remove unnecessary documentation section --- README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index 7a66a9d..22aab92 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,9 @@ const profile = await tsky.profile('did:plc:giohuovwawlijq7jkuysq5dd'); console.log(profile.handle); ``` -## Documentation - -You can find the documentation (TODO: Add link to TSky docs) - ## Links -- [📚 TSky Documentation](#) +- [📚 TSky Documentation](#) (TODO: add docs link) - [🦋 Nimbus on Bluesky](https://bsky.app/profile/nimbus.town) ## Contributing From 987438bc903fa64cb30e8709281cb6b01fb0d1e4 Mon Sep 17 00:00:00 2001 From: Dominik Biedebach Date: Sat, 30 Nov 2024 10:39:25 +0100 Subject: [PATCH 5/6] docs: add link to tsky bluesky --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 22aab92..10004f0 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,7 @@ console.log(profile.handle); ## Links - [📚 TSky Documentation](#) (TODO: add docs link) +- [🦋 TSky on Bluesky](https://bsky.app/profile/tsky.dev) - [🦋 Nimbus on Bluesky](https://bsky.app/profile/nimbus.town) ## Contributing From 555ebad1b9f21d1cd19d4f12d3d46c76eac37667 Mon Sep 17 00:00:00 2001 From: Dominik Biedebach Date: Sat, 30 Nov 2024 10:41:20 +0100 Subject: [PATCH 6/6] docs: add development notice to README & discord links --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 10004f0..ff85def 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,10 @@ 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. @@ -46,6 +50,7 @@ console.log(profile.handle); - [📚 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