Prep for first release

JoeDuncko · May 28, 2021 · 2a62aa3 · 2a62aa3
1 parent 51f904f
commit 2a62aa3
Show file tree

Hide file tree

Showing 4 changed files with 5,807 additions and 3,977 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,31 @@
-# electron-swf-player
+# electron-swf-player
+
+A simple, modern Adobe Flash .swf player built on Electron.
+
+## Installing
+
+- Download the correct version of the app for your platform from [the Releases page](https://github.com/JoeDuncko/electron-swf-player/releases).
+
+Currently only tested on Intel Macs. Builds for other platforms coming soon.
+
+## Developing
+
+Install `node.js`, probably via your package manager.
+
+- `npm install`
+- `npm start`
+
+## Building
+
+### MacOS
+
+- Be on a Mac
+- `npm run make`
+
+### Windows
+
+TBD
+
+### Linux
+
+TBD