Tsk cleanup

README.md

@@ -1,3 +1,91 @@
+# eTIMEbank
+
+` work in progress `
+
+This is a **Proof of Concept** fork of the [Cashu Development Kit (cdk)](https://github.com/cashubtc/cdk) 
+
+Concept is the creation of a FOSS ecash based time-banking application that runs both the wallet client and mint logic for offline and offgrid communities.
+
+This project will be submitted to a [Bitcoin++ Hackathon](https://btcplusplus.dev/) but you are free to fork it and make it your own. PRs welcome.
+
+This project by design not include any Bitcoin elements and does not use satoshis as a unit, it is an exercise in applying a [Chaumian blinded signatures scheme](https://wikipedia.org/wiki/Blind_signature) to the concept of [Time Banking](https://en.wikipedia.org/wiki/Time_banking) 
+
+To know more about the design choices, what time banking is, and the reason why I made this project please refer to the [context.md document within this repository](https://github.com/0xg4tt0/eTIMEbank/blob/main/context.md)
+
+## TO DO
+
+- [x] fork cdk & write project description
+- [x] write context.md
+- [ ] remove Lightning Network logic:
+  - [ ] cdk-lnbits
+  - [ ] cdk-lnd
+  - [ ] cdk-phoenixd
+  - [ ] cdk-strike
+  - [ ] ...
+- [ ] remove Bitcoin logic:
+  - [ ] multi-mint logic
+  - [ ] channel opening/closing
+  - [ ] ...
+- [ ] replace 'sat' with 'time'
+  - [ ] define 'time'
+  - [ ] integrate logic to check real time and 'ecash 'time'
+  - [ ] melt & mint logic remains the same
+  - [ ] ...
+- [ ] testing
+- [ ] deploy on 2 devices
+- [ ] test sharing 'time'
+- [ ] 
+- [ ] 
+- [ ] slap together some slides
+- [ ] drink milk
+- [ ] profit ?
+
+
+Design choices for project
+
+- 100% offline use (no http/API)
+- should run on smartphones made after 2010 (ideally a PWA)
+- access-control to the mint (not open to anyone)
+- etime notes represent minutes of real time (time counter mechanism)
+- no 'withdrawl' or 'deposit' logic (no exchange of etime for other assets)
+- ability to cryptographically query the mint for unique audits (more transparency with verifiability)
+
+## Specifications
+
+*meow*
+*meow*
+
+
+## Relevnt NUTs
+
+*meow*
+*meow*
+
+
+## Feature Request / Future
+
+*meow*
+*meow*
+- multi-mint or federated setup of mints within wallet client (Fedi example)
+- LoRA / mesh network / bluetooth connectivity protocol for clients (offline)
+- APK build
+- reproducible build
+- Translate into multiple languages (not just European ones)
+
+## How to deploy / build
+
+*meow*
+*meow*
+
+
+## License
+
+Code is under the [MIT License](LICENSE)
+
+# Archive of the original README.md from cdk fork
+
+```
+
 > **Warning**
 > This project is in early development, it does however work with real sats! Always use amounts you don't mind loosing.
 
@@ -86,6 +174,8 @@ Unless you explicitly state otherwise, any contribution intentionally submitted
 [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