Merge pull request #497 from mahf708/add-cite

minor clean up

Author: mahf708

.devcontainer/Dockerfile

@@ -0,0 +1,16 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: Particula
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - given-names: Particula
+    family-names: Developers
+doi: 10.5281/zenodo.6634653
+repository-code: 'https://github.com/uncscode/particula'
+url: 'https://uncscode.github.io/particula/'
+license: MIT

.devcontainer/devcontainer.json

@@ -1,9 +1,9 @@
 [project]
 name = "particula"
 description = "a simple, fast, and powerful particle simulator"
-readme = "README.md"
+readme = "readme.md"
 requires-python = ">=3.9"
-license = {file = "LICENSE"}
+license = {file = "license"}
 authors = [
     {name = "aktwo", email="aktwo@users.noreply.github.com"},
     {name = "Gorkowski", email="Gorkowski@users.noreply.github.com"},

README.md

@@ -0,0 +1,14 @@
+
+# Overview
+
+Particula is a Python-based aerosol particle simulator. Its goal is to provide a robust aerosol simulation (including both gas and particle phases) that can be used to answer scientific questions arising from experiments and research endeavors.
+
+The Particula website [https://uncscode.github.io/particula](https://uncscode.github.io/particula) contains the API reference, how-to guides, and tutorials.
+
+## PyPi Installation
+
+If your Python environment is already set up, you can install [`Particula` via pip](https://pypi.org/project/particula/) using the following command:
+
+``` bash
+pip install particula
+```