initial mkdocs, updated installation

.gitattributes

@@ -1,6 +1,8 @@
 # exclude .gitignore and similar from the generated tarball
 .git*           export-ignore
+docs            export-ignore
 examples        export-ignore
+mkdocs.yml      export-ignore
 opmd_beamphysics export-ignore
 
 # exclude CI configurations (useless outside the repo)

README.md

@@ -2,3 +2,25 @@
 Tools for analyzing and viewing particle data in the openPMD standard, extension beamphysics.
 
 https://github.com/DavidSagan/openPMD-standard/blob/EXT_BeamPhysics/EXT_BeamPhysics.md
+
+
+
+Installing openpmd-beamphysics
+==============================
+
+Installing `openpmd-beamphysics` from the `conda-forge` channel can be achieved by adding `conda-forge` to your channels with:
+
+```
+conda config --add channels conda-forge
+```
+
+Once the `conda-forge` channel has been enabled, `openpmd-beamphysics` can be installed with:
+
+```
+conda install openpmd-beamphysics
+```
+
+It is possible to list all of the versions of `openpmd-beamphysics` available on your platform with:
+
+```
+conda search openpmd-beamphysics --channel conda-forge

docs/index.md

@@ -1,13 +1,13 @@
-# Welcome to MkDocs
+# openPMD-beamphysics
 
-For full documentation visit [mkdocs.org](https://mkdocs.org).
+Tools for analyzing and viewing particle data in the openPMD standard, extension beamphysics.
 
-## Commands
+[beamphysics extension](https://github.com/DavidSagan/openPMD-standard/blob/EXT_BeamPhysics/EXT_BeamPhysics.md)
+
+## Python classes
+
+* `ParticleGroup` - Basic class
 
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs help` - Print this help message.
 
 ## Project layout