Create README.md

hawkfalcon · May 3, 2018 · 789aaa6 · 789aaa6
1 parent 3e12d4e
commit 789aaa6
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,21 @@
+# Peregrine - macOS Gist app
+
+## About 
+Peregrine is a free and open source menubar macOS app to instantly share text or code to [gist.github.com](https://gist.github.com).
+
+It is written 100% in Swift 4 and uses Apple's Cocoa API. 
+
+Created for my Senior Project @ Cal Poly SLO
+
+## Features
+* Create Gists from the menubar
+* Login to your GitHub account
+* Browse and share previously created gists
+* Make gists public or secret
+* Import files
+
+## Contributing
+Feel free to contibute
+
+## License
+MIT