diff --git a/README.md b/README.md index b5a1708..f70ed4a 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,44 @@ A small python library with functions to assist engineers. -## Usage +## Getting Started -### Code: +- Install using pip: + +``` +pip install aero-astro-calc +``` + +- Import into your Python project ```python from aero_astro_calc import PlaneStress +``` +## Usage + +Make plane stress object: + +```python stress = PlaneStress(80, -40, 25) +``` + +View the stress on a 2D plane: + +```python stress.plane() ``` -### Output: +![Plane Stress example](images/PlaneStress.png) -![Plane Stress example](PlaneStress.png) +View Mohr's circle of the stresses: + +```python +stress.mohr() +``` + +![Mohr's Circle Example](images/MohrsCircle.png) + +## Contact + +Anson Biggs - [anson@ansonbiggs.com](mailto:anson@ansonbiggs.com) - [@Anson_3D](https://twitter.com/Anson_3D) diff --git a/images/MohrsCircle.png b/images/MohrsCircle.png new file mode 100644 index 0000000..9d56e03 Binary files /dev/null and b/images/MohrsCircle.png differ diff --git a/PlaneStress.png b/images/PlaneStress.png similarity index 100% rename from PlaneStress.png rename to images/PlaneStress.png