Release Version 2.0.0 (#15)

* Release Version 2.0.0 * docs: slight fix formatting
naveen521kk · Oct 16, 2020 · ca393d6 · ca393d6
1 parent 38dc56a
commit ca393d6
Show file tree

Hide file tree

Showing 8 changed files with 238 additions and 201 deletions.
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -6,7 +6,12 @@
 Changelog
 *********
 
-sxcu-v1.0.2
+sxcu-v2.0.1
+===========
+
+[TOB]
+
+sxcu-v2.0.0
 ===========
 
 * Introduced a logger class so that users can know what

diff --git a/docs/source/examples.rst b/docs/source/examples.rst
@@ -41,3 +41,33 @@ Using the class
 .. autosummary::
 
     ~og_properties
+
+A small example using this can be
+
+.. code-block:: python
+
+    import sxcu
+    connector = sxcu.SXCU()
+    props = sxcu.og_properties(color="#000",description="some random post",title="I love SXCU")
+    result = connector.upload_image("foo.png")
+    print(result["url"])
+
+Creating a Short Link
+*********************
+
+The reference for it is
+
+.. autosummary::
+
+    ~SXCU.create_link
+
+A small example illustrating it can be.
+
+.. code-block:: python
+
+    import sxcu
+    connector = sxcu.SXCU()
+    result = connector.create_link("https://sxcu.syrusdark.website")
+    print(result["url"])
+
+should print a shortened URL.