Sneed-Group/sneedium
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Sam Sneed 2024-08-13 13:58:54 +00:00 committed by GitHub
parent 1eee3a31f8
commit 5ef8a09ff0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 13 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -1,10 +1,21 @@
<img src="logo.png" align="right" width="15%"/>
# 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