From afde63dc356c7f120fff5aa0bf7713de39144dde Mon Sep 17 00:00:00 2001 From: dangershony Date: Wed, 18 Oct 2023 16:25:26 +0100 Subject: [PATCH 1/5] add readme text --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8777e90b..2bef8270 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ -# angor \ No newline at end of file +# Angor + +## Introduction + +Angor is a decentralized crowdfunding platform built on the Bitcoin network. Think of it as a trustless, risk-minimized Initial Coin Offering (ICO). With Angor, investors maintain complete control of their funds until the founders actually need to use the funds. + +## License + +Please visit and review the [Custom License](/LICENSE) before contributing. + +## Contributing + +We welcome contributions to the codebase. Please maintain the same code style as the existing code. + +## Documentation + +For detailed documentation and specifications, please refer to our TICO (Trustless ICO) [Specification](https://gist.github.com/dangershony/7683ce7b380c57bf60875739824fd987). From 27941f2a0e713c22a5695d54348fa5c72e9b6750 Mon Sep 17 00:00:00 2001 From: dangershony Date: Wed, 18 Oct 2023 16:30:09 +0100 Subject: [PATCH 2/5] add some more text --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2bef8270..c332a4ca 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ Angor is a decentralized crowdfunding platform built on the Bitcoin network. Think of it as a trustless, risk-minimized Initial Coin Offering (ICO). With Angor, investors maintain complete control of their funds until the founders actually need to use the funds. +For detailed documentation and specifications, please refer to our TICO (Trustless ICO) [Specification](https://gist.github.com/dangershony/7683ce7b380c57bf60875739824fd987). + ## License Please visit and review the [Custom License](/LICENSE) before contributing. @@ -12,6 +14,10 @@ Please visit and review the [Custom License](/LICENSE) before contributing. We welcome contributions to the codebase. Please maintain the same code style as the existing code. -## Documentation +## Features + +Angor is a browser based platform that can be installed as PWA, it can be downloaded directly form the repo or accessed via the web. + +Angor has no backend, it relays on Nostr and a blockchain explorer + -For detailed documentation and specifications, please refer to our TICO (Trustless ICO) [Specification](https://gist.github.com/dangershony/7683ce7b380c57bf60875739824fd987). From e039c72b7a4ade79af95286dd9d2972eadedd148 Mon Sep 17 00:00:00 2001 From: dangershony Date: Wed, 18 Oct 2023 16:31:55 +0100 Subject: [PATCH 3/5] some more text --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c332a4ca..b3726e7d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # Angor -## Introduction - Angor is a decentralized crowdfunding platform built on the Bitcoin network. Think of it as a trustless, risk-minimized Initial Coin Offering (ICO). With Angor, investors maintain complete control of their funds until the founders actually need to use the funds. For detailed documentation and specifications, please refer to our TICO (Trustless ICO) [Specification](https://gist.github.com/dangershony/7683ce7b380c57bf60875739824fd987). @@ -10,14 +8,12 @@ For detailed documentation and specifications, please refer to our TICO (Trustle Please visit and review the [Custom License](/LICENSE) before contributing. -## Contributing - -We welcome contributions to the codebase. Please maintain the same code style as the existing code. - ## Features Angor is a browser based platform that can be installed as PWA, it can be downloaded directly form the repo or accessed via the web. Angor has no backend, it relays on Nostr and a blockchain explorer +## Contributing +We welcome contributions to the codebase. Please maintain the same code style as the existing code. From a14c9b7bbbb05922ebbe0b9fcc9bdba38c9803f7 Mon Sep 17 00:00:00 2001 From: dangershony Date: Wed, 18 Oct 2023 16:36:48 +0100 Subject: [PATCH 4/5] add more description --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b3726e7d..fd2d76f5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Angor -Angor is a decentralized crowdfunding platform built on the Bitcoin network. Think of it as a trustless, risk-minimized Initial Coin Offering (ICO). With Angor, investors maintain complete control of their funds until the founders actually need to use the funds. +Angor is a decentralized crowdfunding platform built on the Bitcoin network. Think of it as a trustless, risk-minimized Initial Coin Offering (ICO). + +With Angor, investors maintain complete control of their funds by locking coins into special timelock contracts until they need to be used. At any given point, investors can recover the funds that have not been released to the founders. For detailed documentation and specifications, please refer to our TICO (Trustless ICO) [Specification](https://gist.github.com/dangershony/7683ce7b380c57bf60875739824fd987). From 714a9b725d98a4bfd526e67349bcecd31d4540b7 Mon Sep 17 00:00:00 2001 From: dangershony Date: Wed, 18 Oct 2023 16:39:25 +0100 Subject: [PATCH 5/5] some fixes --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fd2d76f5..51c82dd0 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # Angor -Angor is a decentralized crowdfunding platform built on the Bitcoin network. Think of it as a trustless, risk-minimized Initial Coin Offering (ICO). +Angor is a decentralized crowdfunding platform built on the Bitcoin network. Think of it as a trustless, risk-minimized ICO. With Angor, investors maintain complete control of their funds by locking coins into special timelock contracts until they need to be used. At any given point, investors can recover the funds that have not been released to the founders. -For detailed documentation and specifications, please refer to our TICO (Trustless ICO) [Specification](https://gist.github.com/dangershony/7683ce7b380c57bf60875739824fd987). +For detailed documentation and specifications, please look here [Specification](https://gist.github.com/dangershony/7683ce7b380c57bf60875739824fd987). ## License