From fc1c1164c74636e85519c96c38bdf9c20f43b3f5 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Tue, 10 Aug 2021 21:24:01 +0200 Subject: [PATCH 1/2] Revised README --- INSTALL.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 9c4a9f967..c657e5bf1 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -16,7 +16,7 @@ Node JS is an open-source server environment required to run Superalgos. **A.** Go to the Node JS [download page](https://nodejs.org/en/download/). -**B.** Download your system’s installer. Select *LTS Recommended for Most Users* and click the big Windows or macOS Installer button. If you are on Linux, the installer is listed further down the page. +**B.** Download your system's installer. Select *LTS Recommended for Most Users* and click the big Windows or macOS Installer button. If you are on Linux, the installer is listed further down the page. **C.** Run the installer with the default configuration — just click Next until Node.JS is fully installed. That's it! You can continue with step 2 (Git Installation). @@ -94,13 +94,13 @@ Before you begin, it is recommended that you set up Chrome/Safari as your defaul **A.** Scroll the page all the way to the top. Find and click the **Fork** button to create your fork/copy of this repository. To fork Superalgos you need a Github account. If you don't have one, go ahead and create it. -**NOTE:** A Fork is required for your contributions to the project. The reason why Superalgos is free and open-source is that the project has set up a Collective Business in which all users may participate. The way to participate is to contribute to make Superalgos better. The project's token is distributed among contributors. +**NOTE:** A Fork is required for your contributions to the project. The reason why Superalgos is free and open-source is that the project has set up a Collective Business in which all users may participate. The way to participate is to contribute to make Superalgos better. The project's token is distributed among contributors. ## 2. Clone Your Fork **A.** Once the fork is created, you will land on the page of your fork. Copy the URL from your browser's address bar. -**B.** In your computer/laptop/server, open a command prompt or terminal. Make sure you are in a directory where you have write permissions (on most systems the terminal will open in your user’s home directory, so you’re good). Clone the git repository using the command: +**B.** In your computer/laptop/server, open a command prompt or terminal. Make sure you are in a directory where you have write permissions (on most systems the terminal will open in your user's home directory, so you're good). Clone the git repository using the command: ``` git clone @@ -116,9 +116,13 @@ This creates the `Superalgos` folder in the current directory, which contains th ## 3. Install Node Dependencies -**A.** After the Superalgos directory has been installed, the final step of installation is to set up the necessary node dependencies. +After the Superalgos directory has been installed, the final step of installation is to set up the necessary node dependencies. In the same command prompt or terminal you just used, type the following: -**B.** In the same command prompt or terminal you just used, type the following command: +``` +cd Superalgos +``` + +That should take you inside the Superalgos folder created by the `git clone` command earlier. Now, run the following command: ``` node setup @@ -233,7 +237,7 @@ We are testing the UI on Google Chrome and Safari on macOS only. It may work on # Running Superalgos on a Headless Linux Server as a Daemon -If you’re running Superalgos on a headless linux server like a Raspberry Pi, you might want to run it as a daemon so it isn’t attached to your current login session. The easiest, most standard way to go about this is probably using `systemd`. Most linux distributions use it as default init system/service manager. +If you're running Superalgos on a headless linux server like a Raspberry Pi, you might want to run it as a daemon so it isn't attached to your current login session. The easiest, most standard way to go about this is probably using `systemd`. Most linux distributions use it as default init system/service manager. ## Using `systemd` @@ -252,7 +256,7 @@ ExecStart=/usr/bin/node run minMemo noBrowser WantedBy=multi-user.target ``` -There is no need to run Superalgos as root so we’re running it as a user. The `minMemo` option assumes you’re running on a small machine like a Raspberry Pi, while `noBrowser` makes sense for running daemonized. +There is no need to run Superalgos as root so we're running it as a user. The `minMemo` option assumes you're running on a small machine like a Raspberry Pi, while `noBrowser` makes sense for running daemonized. Now, as root (or using `sudo`), put the file `superalgos.service` you just created in `/etc/systemd/system/` and issue the command ``` @@ -290,7 +294,7 @@ Once the app finishes loading, an interactive tutorial takes you by the hand and ![welcome-tutorial-00](https://user-images.githubusercontent.com/13994516/107038771-4a6bf100-67bd-11eb-92e0-353525a972a9.gif) - **NOTE:** The tutorial uses Binance or Binance US as the exchange of choice. If you don’t have an account with Binance or Binance US, you will still be able to follow 100% of the tutorial. When you get to the live trading section, keep going even if you don't intend to run the session. You may learn how to work with other exchanges later on. + **NOTE:** The tutorial uses Binance or Binance US as the exchange of choice. If you don't have an account with Binance or Binance US, you will still be able to follow 100% of the tutorial. When you get to the live trading section, keep going even if you don't intend to run the session. You may learn how to work with other exchanges later on. # Docker Deployments From 348367968c5de5f9bb9b05c61dca2519756419c7 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Tue, 10 Aug 2021 21:27:48 +0200 Subject: [PATCH 2/2] Revised README --- README.md | 124 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 73 insertions(+), 51 deletions(-) diff --git a/README.md b/README.md index 9be699418..d7471ba2b 100644 --- a/README.md +++ b/README.md @@ -15,94 +15,116 @@ Superalgos is not just another open-source project. We are an open and welcoming Follow the link to [INSTALL.md](https://github.com/Superalgos/Superalgos/blob/develop/INSTALL.md). -# What is Superalgos? +# The Superalgos Project -## Superalgos is a token-incentivized open-source project. +## Superalgos is a token-incentivized open-source project -The project incentivizes users to continuously improve Superalgos. Users contribute to the codebase, to the library of trading intelligence, and to project development in general -- and earn SA tokens for their contributions. Providing free, high-quality, real-time trading-intelligence over the Superalgos peer-to-peer network is a key activity, also incentivized. +The protocol incentivizes users to improve Superalgos. To do that, users contribute to the codebase, add to the library of trading intelligence, and help with project development in general, earning Superalgos (SA) tokens for their contributions. Protocol-incentivized contributions allow the project to distribute free of charge, high-quality trading intelligence over the Superalgos peer-to-peer network, currently in the making. -## Superalgos is an open-network project built on top of the Internet + Bitcoin + Lighting open networks. +## Superalgos is an open-network project built on top of other open networks: Internet + Bitcoin + Lightning -This means that the Superalgos open network target audience is 8 billion people and that payments of products and services offered through the Superalgos Network are done with bitcoin over the Lighting Network. +Because it's an open network, our target audience is, theoretically, 8 billion people. While all products and services provided by the project are free of charge, third-party products and services distributed through the Superalgos Network will be payable in bitcoin over the Lighting Network. -## Superalgos is a free and open trading-intelligence network anyone can plug-in to emit or consume real-time trading signals. +## The Superalgos Network is an open trading intelligence network distributing trading signals -Signals are cryptographically signed by trading intelligence producers and backed by their token holdings and reputation. The Superalgos p2p Network sorts how signals are distributed, prioritizing signals-consumers with the biggest token holdings. +Anyone may plug in to provide or consume trading signals in a permissionless manner. Signals are cryptographically signed by trading intelligence providers with a reputation reflected in their token holdings. The Superalgos p2p Network prioritizes signals distribution according to the token holdings of consumers. -## Superalgos has the ultimate scalable and defensible business model. +## Superalgos has a scalable and defensible business model -* Everything is free and open source for its user base: trading automation tools + mobile apps for consuming real-time trading intelligence. -* The Superalgos algo-traders community members compete with each other to mine SA tokens by producing high quality real-time trading intelligence which is consumed for free by the Superalgos user base to automate their trading. -* Trading Intelligence is distributed via a protocol-incentivized p2p network with no network fees. -* The long term viability is guaranteed since the business model can not be disrupted. +* Everything is open-source and free of charge for all users: trading automation tools to produce trading intelligence, and mobile apps to consume it. -## Superalgos massive adoption is highly likely since all friction has been removed. +* Algo traders compete to mine SA tokens, producing high-quality, ever-evolving trading intelligence paid for by the protocol. -* Users don’t need to pay for the mobile app to consume trading intelligence. -* Users don’t need to pay for high-quality trading intelligence. -* Algo-traders don’t need to pay for the tools to produce trading intelligence. -* Real-time trading Intelligence does not need to be bought or sold. The Superalgos Project buys real-time trading intelligence (via minting new tokens) from the algo-traders community and distributes it for free to all the user base via its p2p network. -* The Superalgos SA token does not need to be spent to be used, avoiding the need to pay blockchain fees. Only it’s balance is relevant to backup the user profile’s reputation and skin on the game, and in the case of real-time trading intelligence consumers give them priority access to signals. +* Trading Intelligence is distributed via a p2p network with zero network fees. -## Holding the SA Token is the open network business model for all participants. +* The long-term viability is guaranteed since the business model is undisruptable. -* Buying pressure will come from users competing to be among the first to receive the trading-signals. -* Buying pressure will also come from algo-traders competing to be at the top of the list of real-time trading intelligence providers. -* Algo trades make money, users make money, the token appreciates, everyone wins. +## With all friction removed, mass adoption is inevitable -## Superalgos will become one of the most powerful consumer brands on the planet because: +* Users do not pay for the mobile app. -* We are building a brand that is inline and incentivized with our users. -* We have the business acumen and profile of a token-incentivized-open source project. -* The project acts as an union, collecting benefits for its user base, like better exchange fees for all. -* We don’t collect or sell user data. -* We don’t sell ads to anyone. -* We don’t collect or sell users trading information that can be used to front run them. -* We know how we are going to make money, and it is on token appreciation. -* Founders and team are just token holders as any other contributors. +* Users do not pay for trading intelligence. -## Superalgos Mobile Apps will have the best user experience possible because: +* Algo traders do not pay for the tools to produce trading intelligence. -* The best user experience means users should be able to consume top quality, free real-time trading intelligence and autonomously execute trades while they are sleeping. -* Users just need to select their exchange, provide an exchange access token, define their base asset, amount of funds to be traded and trading intelligence providers. -* Their mobile phone will become a 24/7 trading bot plugged into the Superalgos Network to receive trading signals and firing trading orders at any exchange. -* Similar to a bitcoin wallet, anyone will be able to develop Superalgos Mobile Apps for consuming trading-signals. This open competition will be a race to the best UX possible. -* Established crypto wallets or any trading app in general, can plugin into the Superalgos Network and consume real-time trading intelligence for free. +* Trading Intelligence does not need to be bought or sold. The project pays for trading intelligence by minting new tokens and distributes intelligence to all users, free of charge. -## Superalgos does not sell it’s tokens to anyone for any reason. +* The Superalgos (SA) token use case does not require spending, avoiding blockchain fees. Only wallet balance is relevant to determining the reputation and skin in the game of intelligence providers. The same is true for consumers. It is their wallet balance that defines the order of distribution of signals. -SA Tokens are distributed after each software release among the contributors of that release. If you want to mine SA tokens you can start contributing yourself or hire / sponsor someone (usually a developer or trader) to do it on your behalf. +## Holding the SA Token is the business model for all participants -Users are free to buy or sell their SA Tokens. No exchange has listed SA Tokens yet. We expect that to happen soon. +* Buying pressure will come from users competing to be among the first to receive trading signals. + +* Algo traders build up their holdings by producing top trading intelligence and compete for the reputation entailed in their holdings. + +* Project developers earn tokens for their contributions. + +## Superalgos will become a powerful consumer brand because it is user-centric: + +* We are building a brand 100% in line with consumer interests. + +* We cherish the values of a decentralized, token-incentivized, open-source project. + +* The project acts as a union, acquiring benefits for users, like better exchange fees for all. + +* We do not collect or sell user data. + +* We do not sell ads. + +* We do not collect or sell user trading information. + +* We know how we are going to make money: token appreciation. + +* Founders and team are just token holders, like every other contributor. + +## Superalgos Mobile Apps will feature a seamless user experience + +* The app will consume top-quality trading intelligence and autonomously execute trades. + +* Users will select an exchange, provide an exchange access token, define their base asset, initial capital, and trading intelligence providers. + +* A mobile phone will become a 24/7 trading bot plugged into the Superalgos Network, receiving trading signals and firing orders on any exchange. + +* Similar to a bitcoin wallet, anyone will be able to develop Superalgos Mobile Apps to consume trading signals. This open competition will be a race to the best UX possible. + +* Crypto wallets and trading apps will plug into the Superalgos Network and consume real-time trading intelligence for free. + +## The Superalgos Project does not sell tokens + +The protocol distributes Superalgos (SA) Tokens after each software release, among contributors of that release. If you wish to mine tokens, you may start contributing anytime. You may also hire/sponsor someone (usually a developer or trader) to do it on your behalf. # Software Architecture -Superalgos features these 3 main components: +Superalgos features three main components: -1. **Superalgos Platform:** An already functional set of tools designed for algo-traders for automating their own trading and producing trading-signals. +1. **Superalgos Platform:** A set of tools designed for algo-traders to design, build, test, and deploy trading bots and produce trading signals. The platform has been trading live since mid-2020 and is virtually ready to go out of beta. +2. **Superalgos Mobile:** An under-development mobile app reference implementation that consumes existing trading intelligence to automate trading. -2. **Superalgos Mobile:** An under-development mobile app reference implementation for cosuming real-time trading intelligence and automate users trading. +3. **Superalgos Network:** An under-development open p2p network for distributing trading intelligence from providers (algo-traders) to consumers (the project's user base). - -3. **Superalgos Network:** An under-development open p2p network for distributing real-time trading intelligence between producers (algo-traders) and consumers (the project's user base). - - -All of the above is / will be hosted in this repository. +All of the above is or will be hosted in this repository. # Superalgos is User-centric * No ads, anywhere. -* No sign up / logins. + +* No sign-up / logins. + * No user/usage data collection of any kind. + * No user trading information collected or sold. + * Runs 100% on uncompiled code anyone can read and audit. # Superalgos Development Pipeline -* **Superalgos P2P Network:** will allow algo-traders to share trading signals with Superalgos users consuming these signals via a mobile app. -* **Real-time Trading Signals:** will allow users to emit trading signals and be rewarded with SA Tokens. +* **Superalgos P2P Network:** Will allow the project to distribute trading intelligence produced by algo-traders. + +* **Trading Signals:** Will allow providers to broadcast trading signals and be rewarded with SA Tokens. + * **Superalgos Mobile:** Will allow users to consume trading signals for free and autonomously execute trades from their mobile phones. + * **Ethereum Integration:** Will allow mining data from an Ethereum network node, and bring it into the Superalgos workflow. # What is the Superalgos Platform?