docs

demotu · Mar 29, 2020 · ccfd8e1 · ccfd8e1
1 parent 83db5c7
commit ccfd8e1
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -3,29 +3,36 @@
 Python module to detect events in data
 
 The following functions are implemented in detecta:  
- - **detect_peaks.py**: detects peaks in data based on their amplitude and other features.  
- - **detect_onset.py**: detects onset in data based on amplitude threshold.  
- - **detect_cusum.py**: detects abrupt changes in data using cumulative sum algorithm (CUSUM).  
- - **detect_seq.py**: detects initial and final indices of sequential data identical to a parameter.
 
-Installation
-------------
-```
+- **detect_peaks.py**: detects peaks in data based on their amplitude and other features.  
+- **detect_onset.py**: detects onset in data based on amplitude threshold.  
+- **detect_cusum.py**: detects abrupt changes in data using cumulative sum algorithm (CUSUM).  
+- **detect_seq.py**: detects initial and final indices of sequential data identical to a parameter.
+
+## Installation
+
+```bash
 pip install detecta
 ```
 
-Examples
---------
- * [detect_peaks](https://nbviewer.jupyter.org/github/demotu/detecta/blob/master/docs/detect_peaks.ipynb)  
- * [detect_onset](https://nbviewer.jupyter.org/github/demotu/detecta/blob/master/docs/detect_onset.ipynb)  
- * [detect_cusum](https://nbviewer.jupyter.org/github/demotu/detecta/blob/master/docs/detect_cusum.ipynb)  
- * [detect_seq](https://nbviewer.jupyter.org/github/demotu/detecta/blob/master/docs/detect_seq.ipynb)  
+Or
+
+```bash
+conda install -c duartexyz detecta
+```
+
+## Examples
+
+- [detect_peaks](https://nbviewer.jupyter.org/github/demotu/detecta/blob/master/docs/detect_peaks.ipynb)  
+- [detect_onset](https://nbviewer.jupyter.org/github/demotu/detecta/blob/master/docs/detect_onset.ipynb)  
+- [detect_cusum](https://nbviewer.jupyter.org/github/demotu/detecta/blob/master/docs/detect_cusum.ipynb)  
+- [detect_seq](https://nbviewer.jupyter.org/github/demotu/detecta/blob/master/docs/detect_seq.ipynb)  
+
+## How to cite this work
 
-How to cite this work
----------------------
 Here is a suggestion to cite this GitHub repository:
 
-> Duarte, M. (2020) detecta: A Python module to detect events in data. GitHub repository, https://github.com/demotu/detecta.
+> Duarte, M. (2020) detecta: A Python module to detect events in data. GitHub repository, <https://github.com/demotu/detecta>.
 
 And a possible BibTeX entry:
 
@@ -40,6 +47,6 @@ And a possible BibTeX entry:
 }
 ```
 
-License
--------
+## License
+
 The non-software content of this project is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/), and the software code is licensed under the [MIT license](https://opensource.org/licenses/mit-license.php).
diff --git a/detecta/__init__.py b/detecta/__init__.py
@@ -3,4 +3,4 @@
 from .detect_cusum import detect_cusum
 from .detect_seq import detect_seq
 
-__version__ = "0.0.3"
+__version__ = "0.0.5"
diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="detecta",
-    version="0.0.3",
+    version="0.0.5",
     author="Marcos Duarte",
     author_email="duartexyz@gmail.com",
     description="Detect events in data",