Skip to content

Commit

Permalink
Create Usage.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cameronmore committed Dec 17, 2024
1 parent ef16f88 commit 1348ce3
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/Usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# User Guide

## Quickstart

To use statsy, install from PyPi:

```
pip install statsy
```

From there, in your own `Scripy.py` file, import statsy and use normally:

```
from statsy import *
summation( i = 1 , range = 4 , lamda x: x+1 , [[1,2,3,4,5,6,7,8,9]])
```

Alternatively, you may import it under an alias:

```
import statsy as sty
sty.summation( i = 1 , range = 4 , lamda x: x+1 , [[1,2,3,4,5,6,7,8,9]])
```

For a proper guide on usage, stay tuned.

0 comments on commit 1348ce3

Please sign in to comment.