From 5ef8a09ff008b9f9c4de9d7c61a3496e4a42ba39 Mon Sep 17 00:00:00 2001 From: Sam Sneed <163201376+sam-sneed@users.noreply.github.com> Date: Tue, 13 Aug 2024 13:58:54 +0000 Subject: [PATCH] Update README.md --- README.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 1edc2e6..180f83c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,21 @@ # 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.](download.png)](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: ```bash @@ -21,21 +32,9 @@ 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