diff --git a/README.md b/README.md index 9836d0f..d29333d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,20 @@ - + # Sneedium -A basic web browser in Electron. ***Now with a functioning adblocker and privacy redirection technologies!*** +A basic web browser in Electron. ***With a functioning adblocker and privacy redirection technologies!*** + +[![Download latest build.](https://github.com/Sneed-Group/sneedium/blob/master/download.png?raw=true)](https://github.com/Sneed-Group/sneedium/releases/latest) + +## Testing, compiling, and creation notes + +To clone and run this repository you'll need [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line: + +```bash +# Install dependencies +npm install +# Run the app +npm start +``` Supports compiling via electron packager. Install and run it with: @@ -19,25 +32,13 @@ A basic Electron application needs just these files: - `index.html` - A web page to render. This is the app's **renderer process**. - `preload.js` - A content script that runs before the renderer process loads. - -## To Use - -To clone and run this repository you'll need [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line: - -```bash -# Install dependencies -npm install -# Run the app -npm start -``` - ## License -[MIT Modified](LICENSE.md) +[SPL-R5](https://github.com/Sneed-Group/sneedium/blob/master/LICENSE.md) ## Disclaimer -"Insider's Look" builds are outdated and meant for people who are just testing core functionality by default, and aren't interested in changes! If you want changes, compile it or download the new binaries. +"Insider's Look" builds are outdated. If you want changes, compile it or download the new binaries. ## What is Privacy Redirection Technology (PRT)? diff --git a/download.png b/download.png new file mode 100644 index 0000000..4a9dcd1 Binary files /dev/null and b/download.png differ