From 0e09965207ec8d90f514bc0967b35763f06585d6 Mon Sep 17 00:00:00 2001 From: Lucas Sunsi Abreu Date: Sat, 2 Dec 2023 14:57:14 -0300 Subject: [PATCH] Improve README --- README.md | 40 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 05f0887..8b4fb6a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ -# lnurl-kit -###### work in progress. +# LNURL Kit โšก๐Ÿฑ + +A ready-to-useยน implementation of the [LNURL](https://github.com/lnurl/luds) specification. + +This library works as a client so you can support the protocol with ease and even learn about it. + +ยน _Soon to be. Currently it's still on early stages and should be considered experimental._ + +## Current support + +- [LUD-01](https://github.com/lnurl/luds/blob/luds/01.md): โœ… implementation โš ๏ธ example ๐Ÿ†˜ test +- [LUD-02](https://github.com/lnurl/luds/blob/luds/02.md): โœ… implementation ๐Ÿ†˜ example ๐Ÿ†˜ test +- [LUD-03](https://github.com/lnurl/luds/blob/luds/03.md): โœ… implementation ๐Ÿ†˜ example ๐Ÿ†˜ test +- [LUD-04](https://github.com/lnurl/luds/blob/luds/04.md): ๐Ÿ†˜ implementation ๐Ÿ†˜ example ๐Ÿ†˜ test +- [LUD-05](https://github.com/lnurl/luds/blob/luds/05.md): ๐Ÿ†˜ implementation ๐Ÿ†˜ example ๐Ÿ†˜ test +- [LUD-06](https://github.com/lnurl/luds/blob/luds/06.md): โœ… implementation โš ๏ธ example ๐Ÿ†˜ test +- [LUD-07](https://github.com/lnurl/luds/blob/luds/07.md): ๐Ÿ†˜ implementation ๐Ÿ†˜ example ๐Ÿ†˜ test +- [LUD-08](https://github.com/lnurl/luds/blob/luds/08.md): ๐Ÿ†˜ implementation ๐Ÿ†˜ example ๐Ÿ†˜ test +- [LUD-09](https://github.com/lnurl/luds/blob/luds/09.md): ๐Ÿ†˜ implementation ๐Ÿ†˜ example ๐Ÿ†˜ test +- [LUD-10](https://github.com/lnurl/luds/blob/luds/10.md): ๐Ÿ†˜ implementation ๐Ÿ†˜ example ๐Ÿ†˜ test +- [LUD-11](https://github.com/lnurl/luds/blob/luds/11.md): ๐Ÿ†˜ implementation ๐Ÿ†˜ example ๐Ÿ†˜ test +- [LUD-12](https://github.com/lnurl/luds/blob/luds/12.md): ๐Ÿ†˜ implementation ๐Ÿ†˜ example ๐Ÿ†˜ test +- [LUD-13](https://github.com/lnurl/luds/blob/luds/13.md): ๐Ÿ†˜ implementation ๐Ÿ†˜ example ๐Ÿ†˜ test +- [LUD-14](https://github.com/lnurl/luds/blob/luds/14.md): ๐Ÿ†˜ implementation ๐Ÿ†˜ example ๐Ÿ†˜ test +- [LUD-15](https://github.com/lnurl/luds/blob/luds/15.md): ๐Ÿ†˜ implementation ๐Ÿ†˜ example ๐Ÿ†˜ test +- [LUD-16](https://github.com/lnurl/luds/blob/luds/16.md): ๐Ÿ†˜ implementation ๐Ÿ†˜ example ๐Ÿ†˜ test +- [LUD-17](https://github.com/lnurl/luds/blob/luds/17.md): ๐Ÿ†˜ implementation ๐Ÿ†˜ example ๐Ÿ†˜ test +- [LUD-18](https://github.com/lnurl/luds/blob/luds/18.md): ๐Ÿ†˜ implementation ๐Ÿ†˜ example ๐Ÿ†˜ test +- [LUD-19](https://github.com/lnurl/luds/blob/luds/19.md): ๐Ÿ†˜ implementation ๐Ÿ†˜ example ๐Ÿ†˜ test +- [LUD-20](https://github.com/lnurl/luds/blob/luds/20.md): ๐Ÿ†˜ implementation ๐Ÿ†˜ example ๐Ÿ†˜ test + +## Future work +- Remove SOS signs from above list (by implementing, testing and showing stuff) +- Make it client agnostic (currently it uses [reqwest](https://github.com/seanmonstar/reqwest)) +- Make it both sync and async (I want no part in this war) +- Breaking it into client / structures (flexibility right) + +###### Thanks