From f8148897ed660d5b48a427bcbec50c74959aa53b Mon Sep 17 00:00:00 2001
From: Adasauce <adasauce@with.parts>
Date: Thu, 5 Nov 2020 11:49:34 -0400
Subject: [PATCH] Add a lil' readme, as a treat

---
 README.md | 38 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 37 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c3a81ce..535a2fe 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,39 @@
 # mknative
 
-some wrappers around nativefier, mostly for my own use.
\ No newline at end of file
+Some wrappers around nativefier.
+
+## Installation
+
+```
+make install
+```
+
+note: make sure `~/.local/bin` is in your `$PATH`
+
+## Generating apps
+
+```
+mknative -n example-app -s https://example.com
+```
+
+it will look for an example-app.png file in `~/.local/share/mknative/icons/`.
+Just download the icon for the site and place it there before running.
+
+Then check out your application launcher for example-app.
+
+## Uninstalling apps
+
+```
+mknative -u -n $name
+```
+
+## Contributing
+
+I'd like to know if it works for you, or if it's broken somehow.
+
+I'm not looking to create a giant repository of icons, the official nativefier repo on
+github has a ton of them for common sites. Please don't open issues and pull requests to
+add them.
+
+It would be really handy if there were a little script that pulled down the icons as part
+of the `mknative` build step to avoid the manual process of fetching and placing an icon.