diff --git a/README.md b/README.md new file mode 100644 index 0000000..ec3e4d1 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +============ +Electrolyzer +============ + + +.. image:: https://github.com/NREL/electrolyzer/actions/workflows/ci.yml/badge.svg + :target: https://github.com/NREL/electrolyzer/actions/workflows/ci.yml + :alt: CI Status + +.. image:: https://github.com/NREL/electrolyzer/actions/workflows/black.yml/badge.svg + :target: https://github.com/NREL/electrolyzer/actions/workflows/black.yml + :alt: Lint + +Electrolyzer contains performance and cost modeling of H2 production. + + +* Free software: Apache Software License 2.0 + +Quick Installation +------------ + +``pip install git+https://github.com/NREL/electrolyzer.git`` + +For further installation instructions, see the `installing.md` file in the docs folder. + +Features +-------- + +* TODO + +Credits +------- + +This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template. + +.. _Cookiecutter: https://github.com/audreyr/cookiecutter +.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage