Skip to content

Commit 5daf543

Browse files
committed
docs: update README
1 parent 89b9673 commit 5daf543

File tree

4 files changed

+51
-144
lines changed

4 files changed

+51
-144
lines changed

README.md

Lines changed: 19 additions & 144 deletions
Original file line numberDiff line numberDiff line change
@@ -1,159 +1,34 @@
1-
<img src=".erb/img/erb-banner.svg" width="100%" />
1+
# Webbox
22

3-
<br>
3+
> Organize your favorite websites
44
5-
<p>
6-
Electron React Boilerplate uses <a href="https://electron.atom.io/">Electron</a>, <a href="https://facebook.github.io/react/">React</a>, <a href="https://github.com/reactjs/react-router">React Router</a>, <a href="https://webpack.js.org/">Webpack</a> and <a href="https://www.npmjs.com/package/react-refresh">React Fast Refresh</a>.
7-
</p>
5+
[简体中文](./README.zh.md)
86

9-
<br>
7+
## Motivation
108

11-
<div align="center">
9+
As web applications become more and more developed, there are various tabs in my work. Resident and temporary tabs are mixed together, and web pages with different needs are intertwined.
1210

13-
[![Build Status][github-actions-status]][github-actions-url]
14-
[![Github Tag][github-tag-image]][github-tag-url]
15-
[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/Fjy3vfgy5q)
11+
Taking me personally as an example, I personally often need 3 to 5 personal websites, and work-related websites, including design drafts, various online documents, project management, application publishing, code management, etc., need 5 to 10 tabs.
1612

17-
[![OpenCollective](https://opencollective.com/electron-react-boilerplate-594/backers/badge.svg)](#backers)
18-
[![OpenCollective](https://opencollective.com/electron-react-boilerplate-594/sponsors/badge.svg)](#sponsors)
19-
[![StackOverflow][stackoverflow-img]][stackoverflow-url]
13+
And more and more temporary tabs, so my current routine is to open three different browser windows, each creating 20-30 different tabs.
2014

21-
</div>
15+
Managing tabs has become a rigid requirement with the increasing reliance on online tools. The tab management method of conventional browsers can no longer meet the more complex tab management mode.
2216

23-
## Install
17+
![](./docs/terrible-tabs.png)
2418

25-
Clone the repo and install dependencies:
19+
## Feature
2620

27-
```bash
28-
git clone --depth 1 --branch main https://github.com/electron-react-boilerplate/electron-react-boilerplate.git your-project-name
29-
cd your-project-name
30-
npm install
31-
```
21+
- Organize your web pages with a hierarchical tree! Simply drag and drop to categorize your pages
22+
- Clean up uncommonly used pages in time to reduce unnecessary memory usage! Many times all you need is an entry that can be found later
23+
- Split your browser space, split long-term and temporary through'webbox ',
24+
- Record your organization and expansion mode to ensure that you can get back to work as soon as possible every time. No need for the browser to remember the last open state - more and more tabs will only make it difficult for your browser to move forward
3225

33-
**Having issues installing? See our [debugging guide](https://github.com/electron-react-boilerplate/electron-react-boilerplate/issues/400)**
26+
![](./docs/webbox.png)
3427

35-
## Starting Development
28+
It's time to return to a refreshing state!
3629

37-
Start the app in the `dev` environment:
30+
## Try it Now!
3831

39-
```bash
40-
npm start
41-
```
32+
No need to compile, download now!
4233

43-
## Packaging for Production
44-
45-
To package apps for the local platform:
46-
47-
```bash
48-
npm run package
49-
```
50-
51-
## Docs
52-
53-
See our [docs and guides here](https://electron-react-boilerplate.js.org/docs/installation)
54-
55-
## Community
56-
57-
Join our Discord: https://discord.gg/Fjy3vfgy5q
58-
59-
## Sponsors
60-
61-
<a href="https://palette.dev">
62-
<img src=".erb/img/palette-sponsor-banner.svg" width="100%" />
63-
</a>
64-
65-
## Donations
66-
67-
**Donations will ensure the following:**
68-
69-
- 🔨 Long term maintenance of the project
70-
- 🛣 Progress on the [roadmap](https://electron-react-boilerplate.js.org/docs/roadmap)
71-
- 🐛 Quick responses to bug reports and help requests
72-
73-
## Backers
74-
75-
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/electron-react-boilerplate-594#backer)]
76-
77-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/0/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/0/avatar.svg"></a>
78-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/1/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/1/avatar.svg"></a>
79-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/2/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/2/avatar.svg"></a>
80-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/3/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/3/avatar.svg"></a>
81-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/4/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/4/avatar.svg"></a>
82-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/5/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/5/avatar.svg"></a>
83-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/6/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/6/avatar.svg"></a>
84-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/7/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/7/avatar.svg"></a>
85-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/8/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/8/avatar.svg"></a>
86-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/9/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/9/avatar.svg"></a>
87-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/10/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/10/avatar.svg"></a>
88-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/11/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/11/avatar.svg"></a>
89-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/12/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/12/avatar.svg"></a>
90-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/13/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/13/avatar.svg"></a>
91-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/14/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/14/avatar.svg"></a>
92-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/15/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/15/avatar.svg"></a>
93-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/16/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/16/avatar.svg"></a>
94-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/17/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/17/avatar.svg"></a>
95-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/18/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/18/avatar.svg"></a>
96-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/19/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/19/avatar.svg"></a>
97-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/20/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/20/avatar.svg"></a>
98-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/21/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/21/avatar.svg"></a>
99-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/22/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/22/avatar.svg"></a>
100-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/23/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/23/avatar.svg"></a>
101-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/24/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/24/avatar.svg"></a>
102-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/25/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/25/avatar.svg"></a>
103-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/26/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/26/avatar.svg"></a>
104-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/27/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/27/avatar.svg"></a>
105-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/28/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/28/avatar.svg"></a>
106-
<a href="https://opencollective.com/electron-react-boilerplate-594/backer/29/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/backer/29/avatar.svg"></a>
107-
108-
## Sponsors
109-
110-
Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/electron-react-boilerplate-594-594#sponsor)]
111-
112-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/0/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/0/avatar.svg"></a>
113-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/1/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/1/avatar.svg"></a>
114-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/2/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/2/avatar.svg"></a>
115-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/3/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/3/avatar.svg"></a>
116-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/4/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/4/avatar.svg"></a>
117-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/5/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/5/avatar.svg"></a>
118-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/6/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/6/avatar.svg"></a>
119-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/7/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/7/avatar.svg"></a>
120-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/8/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/8/avatar.svg"></a>
121-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/9/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/9/avatar.svg"></a>
122-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/10/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/10/avatar.svg"></a>
123-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/11/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/11/avatar.svg"></a>
124-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/12/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/12/avatar.svg"></a>
125-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/13/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/13/avatar.svg"></a>
126-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/14/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/14/avatar.svg"></a>
127-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/15/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/15/avatar.svg"></a>
128-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/16/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/16/avatar.svg"></a>
129-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/17/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/17/avatar.svg"></a>
130-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/18/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/18/avatar.svg"></a>
131-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/19/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/19/avatar.svg"></a>
132-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/20/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/20/avatar.svg"></a>
133-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/21/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/21/avatar.svg"></a>
134-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/22/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/22/avatar.svg"></a>
135-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/23/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/23/avatar.svg"></a>
136-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/24/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/24/avatar.svg"></a>
137-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/25/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/25/avatar.svg"></a>
138-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/26/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/26/avatar.svg"></a>
139-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/27/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/27/avatar.svg"></a>
140-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/28/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/28/avatar.svg"></a>
141-
<a href="https://opencollective.com/electron-react-boilerplate-594/sponsor/29/website" target="_blank"><img src="https://opencollective.com/electron-react-boilerplate-594/sponsor/29/avatar.svg"></a>
142-
143-
## Maintainers
144-
145-
- [Amila Welihinda](https://github.com/amilajack)
146-
- [John Tran](https://github.com/jooohhn)
147-
- [C. T. Lin](https://github.com/chentsulin)
148-
- [Jhen-Jie Hong](https://github.com/jhen0409)
149-
150-
## License
151-
152-
MIT © [Electron React Boilerplate](https://github.com/electron-react-boilerplate)
153-
154-
[github-actions-status]: https://github.com/electron-react-boilerplate/electron-react-boilerplate/workflows/Test/badge.svg
155-
[github-actions-url]: https://github.com/electron-react-boilerplate/electron-react-boilerplate/actions
156-
[github-tag-image]: https://img.shields.io/github/tag/electron-react-boilerplate/electron-react-boilerplate.svg?label=version
157-
[github-tag-url]: https://github.com/electron-react-boilerplate/electron-react-boilerplate/releases/latest
158-
[stackoverflow-img]: https://img.shields.io/badge/stackoverflow-electron_react_boilerplate-blue.svg
159-
[stackoverflow-url]: https://stackoverflow.com/questions/tagged/electron-react-boilerplate
34+
In [here](https://github.com/msgbyte/webbox/releases) can directly obtain the pre -compiled executable file.

README.zh.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Webbox
2+
3+
> 组织你的常用网站
4+
5+
## 动机
6+
7+
随着web应用的越来越发达,在我的工作中充斥着各种各样的标签页。常驻的与临时的标签页混杂在一起,不同需求的网页交织在一起。
8+
9+
以我个人为例,我个人常需要3~5个个人网站,工作相关的网站,包括设计稿、各种在线文档、项目管理、应用发布、代码管理等需要常开5~10个标签页。
10+
11+
以及更多更多临时的标签页,让我目前常规的常规现状是开启三个不同的浏览器窗口,每个窗口都创建着20~30个不等的标签页。
12+
13+
管理标签页随着对在线工具愈发的依赖变成了一个刚需的要求。而常规浏览器的标签页管理方式已经无法满足更加复杂的标签页管理模式了。
14+
15+
![](./docs/terrible-tabs.png)
16+
17+
## 特性
18+
19+
- 通过层级树来组织你的网页! 将你的页面分门别类,简单拖动就可以
20+
- 及时清理不常用的页面,减少不必要的内存占用!很多时候你需要的仅仅是一个后续能找到的入口
21+
- 分割你的浏览器空间,通过 `webbox` 将长久的和临时的分割,
22+
- 记录你的组织与展开模式,确保每一次都能最快回到工作状态。不再需要浏览器记忆上一次的打开状态 —— 越来越多的标签页只会让你的浏览器难以前行
23+
24+
![](./docs/webbox.png)
25+
26+
是时候回归清爽的状态了!
27+
28+
## 立即使用
29+
30+
无需编译,立即下载!
31+
32+
[这里](https://github.com/msgbyte/webbox/releases)可以直接获得已经预编译好的可执行文件.

docs/terrible-tabs.png

202 KB
Loading

docs/webbox.png

452 KB
Loading

0 commit comments

Comments
 (0)