From 696973399e7837fe24aa912a5478dc3c7590a2ef Mon Sep 17 00:00:00 2001
From: SaulBerrenson <64542974+SaulBerrenson@users.noreply.github.com>
Date: Sat, 25 Jul 2020 21:44:33 +0300
Subject: [PATCH] Create README.md

---
 README.md | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6e4884b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,80 @@
+# BSRetriever
+Library to retrive location from mobile networks information (cell tower | base stations) by MCC, MNC, LAC, CID or get location for BSSID Wi-Fi
+Also you can retrive address from location and build link from location :)
+
+# Features
+
+Base Station Retrivers:
+```
+  -Myinakov
+  -Yandex
+  -Cell2Gps
+  ```
+  Wi-fi bssid Retrivers:
+```
+  -Myinakov
+  -Yandex
+```
+  
+Address Retrivers:
+  ```
+  -Nominatim
+  ```
+Link Builder:
+```
+  -Yandex
+  -OSM
+```
+# Usage Base Station Retrivers
+
+```
+ [Fact]
+        public void TestBS()
+        {
+           var retriver = new Retriver(("358","03", "3303333", "433523333398"))
+               .withLink(new YandexLink())
+               .withLocationRetriver(new RetriverMyinakov())
+               .withRetriverAddress(new Nominatim());
+
+           Assert.True(retriver.Retrive());
+           Assert.Equal(retriver.Location, (60.0092613318, 30.26237712392));
+           Assert.True(retriver.RetriveAddress());
+           
+           retriver.withLocationRetriver(new RetriverYandex());
+           
+           Assert.True(retriver.Retrive());
+           Assert.True(retriver.RetriveAddress());
+           
+           Assert.Equal(retriver.Location, (60.0117645, 30.2631016));
+           Assert.True(retriver.Retrive());
+           Assert.Equal(retriver.Location, (60.0117645, 30.2631016));
+        }
+```
+# Usage Wi-Fi bssid Retrivers
+
+```
+  [Fact]
+        public void TestWifi()
+        {
+
+            var ret = new RetriverWifi("EE:43:F6:D1:B6:90")
+                .withLink(new YandexLink())
+                .withRetriverAddress(new Nominatim())
+                .withLocationRetriver(new RetriverYandexWifi());
+
+           Assert.True(ret.Retrive());
+
+           Assert.Equal(ret.Location, (45.0387230, 39.0997925));
+
+           ret.setData("00:0C:42:1F:65:E9")
+               .withLocationRetriver(new RetriverMyinakovWifi());
+
+           Assert.True(ret.Retrive());
+
+           Assert.Equal(ret.Location, (45.22219677812, 16.54683275428));
+
+        }
+```
+
+
+