🎨 README can be red by setup file.

SimonPop · Jun 23, 2023 · f2cb816 · f2cb816
1 parent 8ef4340
commit f2cb816
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -41,10 +41,9 @@ pip install onion-network
 ### Example
 
 ```python
-from onion_network import onion_graph, plot_onion
-
-G = onion_graph(n=100, gamma=2.5, alpha=3., max_trial=1000)
-
+# Example usage of the onion generation and plotting.
+from onion_network import plot_onion, onion_graph
+G = onion_graph(n=100, gamma=2.5, alpha=3, max_trial=100)
 plot_onion(G, cmap="tab20b")
 ```
 

diff --git a/setup.py b/setup.py
@@ -11,7 +11,7 @@
     name="onion_network",
     version="1.0",
     description="A module for generating and visualizing onion-structured networks!",
-    long_description="To come",
+    long_description=long_description,
     author="Simon Popelier",
     author_email="[email protected]",
     packages=["onion_network"],