Merge pull request #2 from ciegovolador/main

chore(docs): initial description and roadmap

README.md

@@ -1,2 +1,40 @@
 # mostro-tools
-A simple library for develop Mostro p2p clients
+
+Tools for developing Mostro clients.
+
+This package is only providing lower-level functionality. 
+
+
+Roadmap 
+
+Implement Mostro core in TS/JS https://github.com/MostroP2P/mostro-core
+
+  Functions:
+        dispute.ts
+        lib.ts
+        message.ts
+        order.ts
+        rating.ts
+        user.ts
+
+
+Implement Mostro cli methods in TS/JS https://github.com/MostroP2P/mostro-cli
+
+    Functions:
+        listorders       Requests open orders from Mostro pubkey
+        neworder         Create a new buy/sell order on Mostro
+        takesell         Take a sell order from a Mostro pubkey
+        takebuy          Take a buy order from a Mostro pubkey
+        addinvoice       Buyer add a new invoice to receive the payment
+        getdm            Get the latest direct messages from Mostro
+        fiatsent         Send fiat sent message to confirm payment to other user
+        release          Settle the hold invoice and pay to buyer
+        cancel           Cancel a pending order
+        rate             Rate counterpart after a successful trade
+        dispute          Start a dispute
+        admcancel        Cancel an order (only admin)
+        admsettle        Settle a seller's hold invoice (only admin)
+        admlistdisputes  Requests open disputes from Mostro pubkey
+        admaddsolver     Add a new dispute's solver (only admin)
+        admtakedispute   Admin or solver take a Pending dispute (only admin)
+        help             Print this message or the help of the given subcommand(s)