added data to readme

README.md

@@ -10,4 +10,149 @@ For deeper understanding of the ICP < > BTC integration, see the IC wiki article
 
 ## Features
 
-- **Add Users**: Users logs in with their Internet Identity and adds users they want to make payments to.
+- **CRUD Users**: Users logs in with their Internet Identity and adds users they want to make payments to.
+- **Send tokens**: Users can send ckBTC tokens to other users.
+- **Receive notifications**: Users can choose to receive notifications by email or SMS when a payment is received. This uses the [HTTP Outcall](https://internetcomputer.org/docs/current/developer-docs/integrations/https-outcalls/) feature of the Internet Computer.
+- **Transaction history**: Users can view a list of transactions made to the store.
+
+## Architecture
+
+### Backend
+
+The backend is written in Motoko and consist of one canister, `backend`. It exposes the following public methods:
+
+- `getUser` - returns the store configuration for a given principal.
+- `getInvoice` - returns the funding address for a particular user.
+- `updateUser` - updates the store configuration for a given principal.
+- `transferFromSubAccountToCanister` - transfers funds to the canister's account.
+- `transferFromSubAccountToSubAccount` - transfers funds to the another user's account.
+- `getFundingAddress` - returns the funding address for a particular user.
+- `getFundingBalance` - returns the funding balance for a particular user.
+- `getTradingAddress` - returns the trading address for a particular user.
+- `getTradingBalance` - returns the trading balance for a particular user.
+- `setCourierApiKey` - sets the Courier API key used to send email and SMS notifications. Only the canister controller can call this method.
+
+In addition to the public methods, the canister uses a [timer](https://internetcomputer.org/docs/current/motoko/main/timers/) to monitor ledger transactions. When a new transaction is found that matches a configured store – depending on the store settings – the canister will send a notification either by email or SMS.
+
+
+### Frontend
+
+The frontend is written in Javascript/Vite/Vue/TailwindCSS. Users authenticate using the Internet Identity to access their store.
+
+The frontend interacts with the following IC canisters:
+
+- `backend` - to fetch and update user information as well as make transfers.
+- `ckbtc ledger` - to send ckBTC to other users.
+- `ckbtc index` - to fetch transaction history.
+- `internet identity` - to authenticate users.
+
+# Local deployment
+
+## Prerequisites
+
+- [x] Install the [IC SDK](https://internetcomputer.org/docs/current/developer-docs/setup/install/index.mdx).
+- [x] Install [Node.js](https://nodejs.org/en/).
+
+### Step 1: Start a local instance of the Internet Computer
+
+```bash
+dfx start --clean --background
+```
+### Step 2: Deploy the Internet Identity canister
+
+Integration with the [Internet Identity](https://internetcomputer.org/internet-identity/) allows store owners to securely setup and manage their store. The Internet Identity canister is already deployed on the IC mainnet. For local development, you need to deploy it to your local instance of the IC.
+
+```bash
+dfx deploy --network local internet_identity
+```
+
+### Step 3: Save current principal as a variable
+
+The principal will be used when deploying the ledger canister.
+
+```bash
+export OWNER=$(dfx identity get-principal)
+```
+
+### Step 3: Deploy the ckBTC ledger canister
+
+The responsibilities of the ledger canister is to keep track of token balances and handle token transfers.
+
+The ckBTC ledger canister is already deployed on the IC mainnet. ckBTC implements the [ICRC-1](https://internetcomputer.org/docs/current/developer-docs/integrations/icrc-1/) token standard. For local development, we deploy the ledger for an ICRC-1 token mimicking the mainnet setup.
+
+Take a moment to read the details of the call we are making below. Not only are we deploying the ledger canister, we are also:
+
+- Deploying the canister to the same canister ID as the mainnet ledger canister. This is to make it easier to switch between local and mainnet deployments.
+- Naming the token `Local ckBTC / LCKBTC`
+- Setting the owner principal to the principal we saved in the previous step.
+- Minting 100_000_000_000 tokens to the owner principal.
+- Setting the transfer fee to 10 LCKBTC.
+
+```bash
+dfx deploy --network local --specified-id mxzaz-hqaaa-aaaar-qaada-cai icrc1_ledger --argument '
+  (variant {
+    Init = record {
+      token_name = "Local ckBTC";
+      token_symbol = "LCKBTC";
+      minting_account = record {
+        owner = principal "'${OWNER}'";
+      };
+      initial_balances = vec {
+        record {
+          record {
+            owner = principal "'${OWNER}'";
+          };
+          100_000_000_000;
+        };
+      };
+      metadata = vec {};
+      transfer_fee = 10;
+      archive_options = record {
+        trigger_threshold = 2000;
+        num_blocks_to_archive = 1000;
+        controller_id = principal "'${OWNER}'";
+      }
+    }
+  })
+'
+```
+
+### Step 4: Deploy the index canister
+
+The index canister syncs the ledger transactions and indexes them by account.
+
+```bash
+dfx deploy --network local icrc1_index --argument '
+  record {
+   ledger_id = (principal "mxzaz-hqaaa-aaaar-qaada-cai");
+  }
+'
+```
+
+### Step 5: Deploy the backend canister
+
+The backend canister manages the user configuration and sends notifications when a payment is received.
+
+The `--argument '(0)'` argument is used to initialize the canister with `startBlock` set to 0. This is used to tell the canister to start monitoring the ledger from block 0. When deploying to the IC mainnet, this should be set to the current block height to prevent the canister from processing old transactions.
+
+```bash
+dfx deploy --network local icpos --argument '(0)'
+```
+
+### Step 6: Configure the backend canister
+
+ic-pos uses [Courier](https://courier.com/) to send email and SMS notifications. If you want to enable notifications, you need to sign up for a Courier account and and create and API key. Then issue the following command:
+
+```bash
+dfx canister --network local call icpos setCourierApiKey "pk_prod_..."
+```
+### Step 7: Build and run the frontend
+
+Run npm to install dependencies and start the frontend. The frontend will be available at http://localhost:3000.
+
+```bash
+npm install
+npm run dev
+```
+
+