Add installation guide

nlpub · Sep 5, 2023 · 5b77302 · 5b77302
1 parent 781e19a
commit 5b77302
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -13,6 +13,12 @@ This is an implementation of the [Chinese Whispers](https://doi.org/10.3115/1654
 [conda_badge]: https://img.shields.io/conda/vn/conda-forge/chinese-whispers.svg
 [conda_link]: https://anaconda.org/conda-forge/chinese-whispers
 
+## Installation
+
+- [pip](https://pip.pypa.io/): `pip install chinsese_whispers`
+- [Anaconda](https://docs.conda.io/en/latest/): `conda install -c conda-forge chinese-whispers`
+- [Mamba](https://mamba.readthedocs.io/): `mamba install -c conda-forge chinese-whispers`
+
 ## Usage
 
 Given a NetworkX graph `G`, this library can [cluster](https://en.wikipedia.org/wiki/Cluster_analysis) it using the following code:

diff --git a/docs/index.md b/docs/index.md
@@ -2,6 +2,12 @@
 
 This is an implementation of the [Chinese Whispers](https://doi.org/10.3115/1654758.1654774) clustering algorithm in Python. Since this library is based on [NetworkX](https://networkx.github.io/), it is simple to use.
 
+## Installation
+
+- [pip](https://pip.pypa.io/): `pip install chinsese_whispers`
+- [Anaconda](https://docs.conda.io/en/latest/): `conda install -c conda-forge chinese-whispers`
+- [Mamba](https://mamba.readthedocs.io/): `mamba install -c conda-forge chinese-whispers`
+
 ## Usage
 
 Given a NetworkX graph `G`, this library can [cluster](https://en.wikipedia.org/wiki/Cluster_analysis) it using the following code: