Added:example

shenxiangzhuang · Jun 20, 2023 · 9eb732d · 9eb732d
1 parent 674db52
commit 9eb732d
Show file tree

Hide file tree

Showing 11 changed files with 14,538 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,32 @@
-# [Py]S-ESD
+<p align="center" style="font-size:40px; margin:0px 10px 0px 10px">
+    <em>[Py]S-ESD</em>
+</p>
+<p align="center">
+    <em>Seasonal Extreme Studentized Deviate(S-ESD) in Python.
+</em>
+</p>
+
+# About
 Seasonal Extreme Studentized Deviate(S-ESD) in Python.
+
+# Installation
+
+Get latest version from PyPI:
+
+```shell
+pip install pysesd
+```
+
+# Examples
+
+## Simple example
+
+![](./figures/simple.png)
+
+## Twitter example
+
+![](./figures/twitter.png)
+
+
+# References
+- [twitter/AnomalyDetection](https://github.com/twitter/AnomalyDetection)