Skip to content

Commit f9ed517

Browse files
committed
Updated docs, fixed linter errors
1 parent be0551c commit f9ed517

File tree

4 files changed

+21
-6
lines changed

4 files changed

+21
-6
lines changed

README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ A minimal web browser for the distributed web
77

88
## Running
99

10+
Download an installer from the [releases page](https://github.com/RangerMauve/agregore-browser/releases)
11+
12+
**OR**
13+
1014
- Clone the repo
1115
- `npm install`
1216
- `bash ./rebuild.sh`
@@ -27,6 +31,12 @@ A minimal web browser for the distributed web
2731

2832
PRs for more protocols are welcome.
2933

34+
## Contributing
35+
36+
Feel free to open a Github issue if you wish to tackle one of the items on the roadmap, or message @RangerMauve directly on whatever platform you can find them on.
37+
38+
This project uses the [StandardJS](https://standardjs.com/) code style. Please format your code with `standard --fix` or run `npm run lint`.
39+
3040
## Roadmap
3141

3242
- [x] Basic browser features
@@ -40,15 +50,18 @@ PRs for more protocols are welcome.
4050
- [ ] Loading pretty urls with index.html
4151
- [ ] IPNS?
4252
- [ ] Basic BitTorrent support (loading)
53+
- [ ] Load web page when opening magnet link
54+
- [ ] `bt://` protocol for loading individual files
4355
- [ ] Better navigation UX
4456
- [x] Multiple windows
4557
- [ ] Shortcuts for window creation
4658
- [x] Only allow single instance of the app (reuse the protocol handlers across windows)
4759
- [x] Make sure protocol handlers open correct URL
4860
- [ ] Make sure page titles update the window title
49-
- [ ] Keyboard shortcuts
61+
- [ ] Keyboard shortcuts (use Menu bar with accelerator keys)
5062
- [x] Dev tools
51-
- [ ] Navigation
63+
- `ctrl+[` and `ctrl+]` for navigating history
64+
- `ctrl+l` for selecting the navigation bar
5265
- [ ] Better browser history
5366
- [ ] Save history to a DB
5467
- [ ] Search through history?
@@ -58,6 +71,7 @@ PRs for more protocols are welcome.
5871
- [ ] PUT/DELETE methods for files / folders
5972
- [ ] Track created archives for origin in a DB
6073
- [ ] Access control prompt for writing to origin
74+
- [ ] fetch API for IPFS (look at how their proxy works?)
6175
- [x] WebXR - Make sure it's working!
6276
- [ ] Web extension support via [electron-extensions](https://github.com/sentialx/electron-extensions)
6377
- [ ] Somewhere to render badges

app/main.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ function createWindow (url) {
3434

3535
// and load the index.html of the app.
3636
win.loadURL(toLoad.href)
37-
37+
3838
// Open the DevTools.
39-
if (process.env.MODE == 'debug') {
39+
if (process.env.MODE === 'debug') {
4040
win.webContents.openDevTools()
4141
}
4242
}

app/script.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ const { Menu, MenuItem } = remote
44
const webview = $('#view')
55

66
webview.addEventListener('dom-ready', () => {
7-
if (process.env.MODE == 'debug') {
7+
if (process.env.MODE === 'debug') {
88
webview.openDevTools()
99
}
1010
})

package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
"start": "electron .",
99
"debug": "env MODE=debug electron .",
1010
"electron-rebuild": "electron-rebuild",
11-
"build": "electron-builder build -mwl --publish never"
11+
"build": "electron-builder build -mwl --publish never",
12+
"lint": "standard --fix"
1213
},
1314
"build": {
1415
"productName": "Agregore Browser",

0 commit comments

Comments
 (0)