Merge pull request #12 from DAI-Lab/readme_historymd

Update README and Add HistoryMD

Author: amzhao16

HISTORY.md

@@ -1 +1,13 @@
-# History
+History
+=======
+## 0.1.0 - 2025-05-01
+
+First PyGridSim release to PyPI: https://pypi.org/project/pygridsim/
+
+* Add Proper Packaging - [PR #1](https://github.com/DAI-Lab/PyGridSim/pull/1) by @sarahmish
+* Add Type Checking, Exports, Enum Config File, Generators/PV - [PR #3](https://github.com/DAI-Lab/PyGridSim/pull/3) by @amzhao16
+* Pass Github Actions - [PR #5](https://github.com/DAI-Lab/PyGridSim/pull/5) by @amzhao16
+* Add Naming Consistency, Customization Tests - [PR #6](https://github.com/DAI-Lab/PyGridSim/pull/6) by @amzhao16
+* Support User Query Functions - [PR #7](https://github.com/DAI-Lab/PyGridSim/pull/7) by @amzhao16
+* Enhance Results.py - [PR #8](https://github.com/DAI-Lab/PyGridSim/pull/8) by @amzhao16
+* Update README - [PR #11](https://github.com/DAI-Lab/PyGridSim/pull/11) by @amzhao16

README.md

@@ -75,6 +75,7 @@ Users of PyGridSim have the option between creating a fully customized circuit a
 
 ## Customized Circuit Creation
 ```python
+from pygridsim import PyGridSim
 circuit = PyGridSim()
 
 # Add Custom Source and Load
@@ -99,6 +100,7 @@ Note that the losses here are expressed in Watts, and the Voltages in Volts. The
 
 ## Defaults-Based Circuit Creation
 ```python
+from pygridsim import PyGridSim
 circuit = PyGridSim()
 
 # Add Custom Source and Load