Jelajahi Sumber

chore: update readme

thesimplekid 8 bulan lalu
induk
melakukan
dec11e232a
1 mengubah file dengan 46 tambahan dan 16 penghapusan
  1. 46 16
      README.md

+ 46 - 16
README.md

@@ -23,22 +23,33 @@ The project is split up into several crates in the `crates/` directory:
 
 ## Implemented [NUTs](https://github.com/cashubtc/nuts/):
 
-- :heavy_check_mark: [NUT-00](https://github.com/cashubtc/nuts/blob/main/00.md)
-- :heavy_check_mark: [NUT-01](https://github.com/cashubtc/nuts/blob/main/01.md)
-- :heavy_check_mark: [NUT-02](https://github.com/cashubtc/nuts/blob/main/02.md)
-- :heavy_check_mark: [NUT-03](https://github.com/cashubtc/nuts/blob/main/03.md)
-- :heavy_check_mark: [NUT-04](https://github.com/cashubtc/nuts/blob/main/04.md)
-- :heavy_check_mark: [NUT-05](https://github.com/cashubtc/nuts/blob/main/05.md)
-- :heavy_check_mark: [NUT-06](https://github.com/cashubtc/nuts/blob/main/06.md)
-- :heavy_check_mark: [NUT-07](https://github.com/cashubtc/nuts/blob/main/07.md)
-- :heavy_check_mark: [NUT-08](https://github.com/cashubtc/nuts/blob/main/08.md)
-- :heavy_check_mark: [NUT-09](https://github.com/cashubtc/nuts/blob/main/09.md)
-- :heavy_check_mark: [NUT-10](https://github.com/cashubtc/nuts/blob/main/10.md)
-- :heavy_check_mark: [NUT-11](https://github.com/cashubtc/nuts/blob/main/11.md)
-- :heavy_check_mark: [NUT-12](https://github.com/cashubtc/nuts/blob/main/12.md)
-- :heavy_check_mark: [NUT-13](https://github.com/cashubtc/nuts/blob/main/13.md)
-- :heavy_check_mark: [NUT-14](https://github.com/cashubtc/nuts/blob/main/14.md)
-- :heavy_check_mark: [NUT-15](https://github.com/cashubtc/nuts/blob/main/15.md)
+### Mandatory
+
+| NUT #    | Description                       |
+|----------|-----------------------------------|
+| [00][00] | Cryptography and Models           |
+| [01][01] | Mint public keys                  |
+| [02][02] | Keysets and fees                  |
+| [03][03] | Swapping tokens                   |
+| [04][04] | Minting tokens                    |
+| [05][05] | Melting tokens                    |
+| [06][06] | Mint info                         |
+
+### Optional
+
+| # | Description | Status
+| --- | --- | --- |
+| [07][07] | Token state check | :heavy_check_mark: |
+| [08][08] | Overpaid Lightning fees | :heavy_check_mark: |
+| [09][09] | Signature restore | :heavy_check_mark: |
+| [10][10] | Spending conditions | :heavy_check_mark: |
+| [11][11] | Pay-To-Pubkey (P2PK) | :heavy_check_mark: |
+| [12][12] | DLEQ proofs | :heavy_check_mark: |
+| [13][13] | Deterministic secrets | :heavy_check_mark: |
+| [14][14] | Hashed Timelock Contracts (HTLCs) | :heavy_check_mark: |
+| [15][15] | Partial multi-path payments (MPP) | :heavy_check_mark: |
+| [16][16] | Animated QR codes | :x: |
+| [17][17] | WebSocket subscriptions  | :construction: |
 
 ## Bindings
 
@@ -53,3 +64,22 @@ Code is under the [MIT License](LICENSE)
 All contributions welcome.
 
 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed as above, without any additional terms or conditions.
+
+[00]: https://github.com/cashubtc/nuts/blob/main/00.md
+[01]: https://github.com/cashubtc/nuts/blob/main/01.md
+[02]: https://github.com/cashubtc/nuts/blob/main/02.md
+[03]: https://github.com/cashubtc/nuts/blob/main/03.md
+[04]: https://github.com/cashubtc/nuts/blob/main/04.md
+[05]: https://github.com/cashubtc/nuts/blob/main/05.md
+[06]: https://github.com/cashubtc/nuts/blob/main/06.md
+[07]: https://github.com/cashubtc/nuts/blob/main/07.md
+[08]: https://github.com/cashubtc/nuts/blob/main/08.md
+[09]: https://github.com/cashubtc/nuts/blob/main/09.md
+[10]: https://github.com/cashubtc/nuts/blob/main/10.md
+[11]: https://github.com/cashubtc/nuts/blob/main/11.md
+[12]: https://github.com/cashubtc/nuts/blob/main/12.md
+[13]: https://github.com/cashubtc/nuts/blob/main/13.md
+[14]: https://github.com/cashubtc/nuts/blob/main/14.md
+[15]: https://github.com/cashubtc/nuts/blob/main/15.md
+[16]: https://github.com/cashubtc/nuts/blob/main/16.md
+[17]: https://github.com/cashubtc/nuts/blob/main/17.md