housekeeping (#36)

- update readme
- "benchmark" in actions

.github/workflows/gate.yml

@@ -37,3 +37,18 @@ jobs:
         uses: actions-rust-lang/setup-rust-toolchain@v1
       - name: run unit tests
         run: cargo test
+
+  benchmark:
+    if: github.head_ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: setup rust
+      uses: actions-rust-lang/setup-rust-toolchain@v1
+    - name: restore cache
+      uses: actions/cache@v4
+      with:
+        path: target/criterion
+        key: bench-${{ runner.os }}
+    - name: benchmark
+      run: cargo bench --bench traquer -- --noplot

README.md

@@ -2,7 +2,38 @@
 
 WIP - api is not stable.
 
-technical analysis library that gives you false hope that you can beat the market.
+Technical analysis library that gives you false hope that you can beat the market.
+
+## installation
+1. (optional) https://rustup.rs/
+2. (optional) cargo new <lib name>
+3. cargo add traquer
+
+## quick start
+
+```rust
+use traquer::smooth;
+
+fn main() {
+    dbg!(smooth::ewma(&vec![1.0,2.0,3.0,4.0,5.0], 3).collect::<Vec<f64>>());
+}
+```
+
+## contributing
+encouraged.
+
+- git clone git@github.com:chungg/traquer.git
+- https://rustup.rs/
+- cargo test
+- cargo bench
+
+## types of indicators
+- momentum - indicators where crossing a threshold (zero line) may signify opportunities.
+- trend - indicators where the direction (uptrend/downtrend) may signify opportunities.
+- volume - indicators that factor in how much an asset has been traded in a period of time.
+- smooth - moving average functions. often used to track trend, levels of support, breakouts,
+           etc... Is the same scale as input data.
+
 
 ## TODO
 - docs