Improving documentation

README.md

@@ -2,32 +2,52 @@
 
 <img src="https://raw.githubusercontent.com/shinzlet/oildrop/media/oildrop-hero.png" alt="An image showing Oildrop in light and dark mode. Several scripts are listed in its overview panel.">
 
-Oildrop is a userscript manager designed to be audited by anyone in less than 30 minutes.
-It uses around 500 lines of JavaScript (excluding comments), does not communicate
-with a server, and is easily modifiable to suit your needs.
+Oildrop is a userscript manager for Firefox. It was designed to be audited by anyone in less than
+30 minutes, does not communicate with a server, and is easily modifiable to suit your needs.
 
 ## Features
 - Sleek, modern interface
 - Manage scripts and styles in one extension
 - Dark and light theme
 - Import / Export your scripts with JSON
 - GPLv3 License
-- Only 500 lines of code
+- Less than 600 lines of code (no golfing required)
 - Easy to tweak to your needs
+- Designed with accessibility in mind
 
-## Limitations
-- Oildrop is not bundled with a fully-fledged code editor. For complicated scripts, using your editor of choice is reccommended.
-- 
+## Installation
+Oildrop can be installed via several means, the easiest of which is the
+[Firefox Addon Store](https://addons.mozilla.org/en-CA/firefox/addon/oildrop/).
+
+You can also download the latest signed release from GitHub, which is easier to
+audit - this is what I'd reccommend doing. Unlike the first method, you will not
+receive automatic updates. If you go this route, see
+["How to Audit Oildrop"](#how-to-audit-oildrop).
+
+If you want to modify Oildrop for your needs, instructions are available below for
+[development](#development), [building, and self-signing](#building-and-signing) the
+extension.
+
+## How to Audit Oildrop
+TODO
 
 ## Development
 Oildrop is written in plain HTML and JavaScript, but uses sass to accelerate styling.
-In order to work on Oildrop, ensure you've installed dart-sass, then run `make watch`.
-This will automatically watch and compile your scss into the `css` folder.
+If you're tweaking Oildrop for personal use, you can edit the compiled CSS and ignore
+the build process. However, if you want to contribute to or fork Oildrop, you'll want
+to use the Sass pipeline. To do so, [install dart-sass](https://sass-lang.com/install),
+then run `make watch`. This will automatically watch and compile your scss into the `css` folder.
+
+To test the extension, you will need to have [`web-ext`
+installed](https://extensionworkshop.com/documentation/develop/getting-started-with-web-ext/).
+Then, invoke `make run` to open a development browser with Oildrop loaded.
 
-To test the extension, you should have `web-ext` installed. Then, you can run `make run`
-to open a development browser with Oildrop loaded.
+## Building and Signing
 
-TODO: Add instructions for building / signing
+## Limitations
+- Oildrop only works in Firefox. Adding the neccessary polyfills to make it cross-platform would have easily doubled the codebase. That being said, porting it would not be a monumental challenge, and forks are welcomed.
+- Oildrop's editor is good enough for quick scripting, but is not intended to replace your editor of choice. For complicated scripts, you should write code elsewhere and import it into Oildrop.
+- Because it isn't needed for most tasks, the GreaseMonkey `GM_` API is not implemented in Oildrop. Increasing compatibility with other userscript managers is something I'd like to look into, however.
 
 ## Contributors
 - [Seth Hinz](https://github.com/shinzlet), [[email protected]](mailto:[email protected])

manifest.json

@@ -1,7 +1,7 @@
 {
 	"manifest_version": 2,
 	"name": "Oildrop",
-	"version": "1.0.0",
+	"version": "1.0.1",
 	"description": "An open-source userscript manager that you can audit on your own.",
 	"permissions": [
 		"storage",

ui.html

@@ -52,7 +52,7 @@
 	    </div>
 
 	    <footer id="footer">
-		<span>Version 1.0.0</span>
+		<span>Version 1.0.1</span>
 
 		<a href="https://github.com/shinzlet/oildrop">
 		    <div id="github-logo" title="Link to Oildrop's GitHub repository"></div>