sneedium/README.md

46 lines
1.7 KiB
Markdown
Raw Normal View History

2024-08-13 14:02:43 +00:00
<img src="https://github.com/Sneed-Group/sneedium/blob/master/logo.png?raw=true" align="right" width="15%"/>
2023-03-09 14:03:04 +00:00
2024-08-12 20:22:51 +00:00
# Sneedium
2024-08-13 13:58:54 +00:00
A basic web browser in Electron. ***With a functioning adblocker and privacy redirection technologies!***
2023-03-02 21:42:38 +00:00
2024-09-04 00:36:14 +00:00
[![Download latest build.](https://github.com/Sneed-Group/sneedium/blob/master/download.png?raw=true)](https://github.com/Sneed-Group/sneedium/releases)
2024-08-13 13:56:20 +00:00
2024-08-13 13:58:54 +00:00
## 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
```
2023-03-09 15:20:27 +00:00
Supports compiling via electron packager. Install and run it with:
2023-03-09 15:19:50 +00:00
```bash
npm install --save-dev electron-packager
2023-03-09 15:20:27 +00:00
npm run make
2023-03-09 15:19:50 +00:00
```
2023-03-09 15:24:23 +00:00
Keep in mind you also need a copy of the WINE project and need to be on Linux.
2023-03-02 21:42:38 +00:00
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
2024-08-13 13:58:54 +00:00
[SPL-R5](https://github.com/Sneed-Group/sneedium/blob/master/LICENSE.md)
2023-03-03 00:34:30 +00:00
## Disclaimer
2024-08-13 13:56:20 +00:00
"Insider's Look" builds are outdated. If you want changes, compile it or download the new binaries.
2023-03-09 14:05:52 +00:00
2023-03-09 14:28:46 +00:00
## What is Privacy Redirection Technology (PRT)?
2023-03-09 14:05:52 +00:00
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.