chores: added usage docs to readme

Author: opensaucerer

readme.md

@@ -22,10 +22,34 @@ or using nose2
 pip install requirements.txt && python -m nose2
 ```
 
-# Bundling
+# Usage
 
-To bundle the library, run the following command:
+### Instantiate the client
 
+```python
+from lighthouse import Lighthouse
+
+# use token from env variable LIGHTHOUSE_TOKEN
+lh = LighthouseClient()
+
+# or you can pass token as parameter
+lh = LighthouseClient(token="your_token")
 ```
-python setup.py
+
+### Uploading a file
+
+```python
+from lighthouse import Lighthouse
+lh = Lighthouse()
+response = lh.upload_file("path/to/file")
+print(response) # prints a dict containing the cid of the file
+```
+
+### Uploading a directory
+
+```python
+from lighthouse import Lighthouse
+lh = Lighthouse("my-lightouse-token")
+response = lh.deploy("path/to/directory")
+print(response) # prints a dict containing the root cid of the directory
 ```

tests/test_deploy.py

@@ -11,6 +11,12 @@ def setUp(self) -> None:
         """setup test environment"""
         parse_env()
 
+    def test_env(self):
+        """test env var"""
+        self.assertNotEqual(
+            os.environ.get("LIGHTHOUSE_TOKEN"), None, "token is not None"
+        )
+
     def test_deploy_file(self):
         """test deploy function"""
         l = Lighthouse()  # will use env var
@@ -20,7 +26,7 @@ def test_deploy_file(self):
 
     def test_deploy_dir(self):
         """test deploy function"""
-        l = Lighthouse(os.environ["LIGHTHOUSE_TOKEN"])
+        l = Lighthouse(os.environ.get("LIGHTHOUSE_TOKEN"))
         res = l.deploy("tests/testdir/")
         self.assertNotEqual(res.get("data"), None, "data is None")
         self.assertIsInstance(res.get("data"), dict, "data is a dict")