1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a9a1943
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# MSTAT
+
+Record the memory usage of a process over time.
+
+# How to use MSTAT
+
+```shell
+mstat <pid_here>
+```
+
+## Plotting
+
+Requires `gnuplot` to be installed
+
+```shell
+mstat_plot <pid_here>.mstat
+```
+
+## CSV export
+
+```shell
+mstat_export <pid_here>.mstat > data.csv
+```
+