From 17540a0d17bd528e27ebf403265416d6c1c9dcf6 Mon Sep 17 00:00:00 2001
From: mraniki <8766259+mraniki@users.noreply.github.com>
Date: Thu, 6 Jul 2023 15:15:38 +0200
Subject: [PATCH] Update README.md
---
README.md | 80 +++++++++++++++++++++++++++++--------------------------
1 file changed, 42 insertions(+), 38 deletions(-)
diff --git a/README.md b/README.md
index 4427212..b4d9468 100644
--- a/README.md
+++ b/README.md
@@ -1,38 +1,42 @@
-# Find my order
-
-| 
| A python package to identify and
parse order for trade execution. |
-| ------------- | ------------- |
-|
[](https://talkytrader.gitbook.io/talky/) [](https://pypi.org/project/findmyorder/) 
[](https://github.com/mraniki/findmyorder/actions/workflows/%F0%9F%91%B7%E2%80%8D%E2%99%82%EF%B8%8FFlow.yml) [](https://codebeat.co/projects/github-com-mraniki-findmyorder-main) [](https://codecov.io/gh/mraniki/findmyorder) | Find & Parse a trade order for execution|
-
-Key features:
-
-- Identify an order with word `BUY SELL LONG SHORT` or your own `Bull`, `to the moon`, `pump` via config file
-- Parse and return a structured order with action and instrument as mandatory
-- Capability to map a given instrument to a new one (e.g BTC to WBTC or ETHUSD to ETH)
-- Settings for custom options
-
-## Install
-
-`pip install findmyorder`
-
-## How to use it
-
-```python
->>> from findmyorder import FindMyOrder
-fmo = FindMyOrder()
-msg_order = "buy EURUSD sl=1000 tp=1000 q=1 comment=FOMC"
-order = await fmo.get_order(msg_order)
-#{'action': 'BUY', 'instrument': 'EURUSD', 'stop_loss': '1000', 'take_profit': '1000', 'quantity': '2', 'order_type': None, 'leverage_type': None, 'comment': None, 'timestamp': datetime.datetime(2023, 5, 3, 12, 10, 28, 731282, tzinfo=datetime.timezone.utc)}
-```
-
-### Example
-
-[example](https://github.com/mraniki/findmyorder/blob/main/examples/example.py)
-
-### Real use case
-
-[TalkyTrader](https://github.com/mraniki/tt)
-
-## Documentation
-
-[](https://talkytrader.gitbook.io/talky/)
+
+
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+ 
+ 
+ 
+ 
+ 
+ 
+ |
+
+ Find My order,
+ a parsing package to find trading order
+ |
+
+
+
+How to use it
+
+
+ from findmyorder import FindMyOrder
+ fmo = FindMyOrder()
+ msg_order = "buy EURUSD sl=1000 tp=1000 q=1 comment=FOMC"
+ order = await fmo.get_order(msg_order)
+ #{'action': 'BUY', 'instrument': 'EURUSD', 'stop_loss': '1000', 'take_profit': '1000', 'quantity': '2', 'order_type': None, 'leverage_type': None, 'comment': None, 'timestamp': datetime.datetime(2023, 5, 3, 12, 10, 28, 731282, tzinfo=datetime.timezone.utc)}
+
+
+
+Example
+
+https://github.com/mraniki/findmyorder/blob/6211e686abf1321ab3d5a8ac33068f854b0e9336/examples/example.py#L1-L90