mirror of
https://github.com/Sneed-Group/sneedium-www
synced 2024-12-23 18:32:24 -06:00
Update README.md
This commit is contained in:
parent
e259661412
commit
37be6d7528
1 changed files with 45 additions and 2 deletions
47
README.md
47
README.md
|
@ -1,2 +1,45 @@
|
||||||
# sneedium-www
|
<img src="https://github.com/Sneed-Group/sneedium/blob/master/logo.png?raw=true" align="right" width="15%"/>
|
||||||
sneedium browser website
|
|
||||||
|
# Sneedium
|
||||||
|
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:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install --save-dev electron-packager
|
||||||
|
npm run make
|
||||||
|
```
|
||||||
|
|
||||||
|
Keep in mind you also need a copy of the WINE project and need to be on Linux.
|
||||||
|
|
||||||
|
A basic Electron application needs just these files:
|
||||||
|
|
||||||
|
- `package.json` - Points to the app's main file and lists its details and dependencies.
|
||||||
|
- `main.js` - Starts the app and creates a browser window to render HTML. This is the app's **main process**.
|
||||||
|
- `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.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
[SPL-R5](https://github.com/Sneed-Group/sneedium/blob/master/LICENSE.md)
|
||||||
|
|
||||||
|
## Disclaimer
|
||||||
|
|
||||||
|
"Insider's Look" builds are outdated. If you want changes, compile it or download the new binaries.
|
||||||
|
|
||||||
|
## What is Privacy Redirection Technology (PRT)?
|
||||||
|
|
||||||
|
This is a simple technology that replaces a bad URL with a more privacy friendly service, when we know that ADs aren't 100% blocked, or just to provide a better UX. TLDR: Clickjacking for the greater good.
|
||||||
|
|
Loading…
Reference in a new issue