Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
lsunsi committed Dec 2, 2023
1 parent 15ca29e commit 0e09965
Showing 1 changed file with 38 additions and 2 deletions.
40 changes: 38 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 0e09965

Please sign in to comment.