Merge branch 'main' of https://github.com/alienbrett/financial-securi…

…ty-classes
alienbrett · Sep 5, 2022 · 08c8f83 · 08c8f83
2 parents c85b1ce + 8596ffd
commit 08c8f83
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,6 +1,22 @@
-# financial-security-classes
+# <img src="https://raw.githubusercontent.com/alienbrett/financial-security-classes/main/contract-icon.png" alt="FinSec icon" width="60"/> FinSec
+![open issues](https://img.shields.io/github/issues/alienbrett/financial-security-classes)
+![pypi version](https://img.shields.io/pypi/v/financial-security-classes)
+![license](https://img.shields.io/pypi/l/financial-security-classes)
+![pypi version](https://img.shields.io/pypi/pyversions/financial-security-classes)
+
 Pure python financial securities dataclasses, as foundation for other projects
 
+## Install
+```bash
+## Install from pypi
+pip install financial-security-classes
+
+## or from the repo directly
+git clone https://github.com/alienbrett/financial-security-classes
+cd financial-security-classes
+pip install -e .
+```
+
 ## Examples
 
 First set up and import the library

diff --git a/contract-icon.png b/contract-icon.png