Skip to content

Commit

Permalink
feat: update README & CI
Browse files Browse the repository at this point in the history
  • Loading branch information
cnwangjie committed Aug 11, 2018
1 parent 713baae commit a6fe1bd
Show file tree
Hide file tree
Showing 3 changed files with 107 additions and 9 deletions.
82 changes: 82 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
version: 2
jobs:
install_dependencies:
docker:
- image: circleci/node:8.11.3-jessie
working_directory: ~/ext
steps:
- checkout
- restore_cache:
key: deps-{{ checksum "yarn.lock" }}
- run:
command: yarn
- save_cache:
key: deps-{{ checksum "yarn.lock" }}
paths: ~/ext/node_modules
- save_cache:
key: code-{{ .Environment.CIRCLE_SHA1 }}
paths: ~/ext

build:
docker:
- image: circleci/node:8.11.3-jessie
working_directory: ~/ext
steps:
- restore_cache:
key: code-{{ .Environment.CIRCLE_SHA1 }}
- run: yarn build
- save_cache:
key: build-{{ .Environment.CIRCLE_SHA1 }}
paths: ~/ext

publish:
docker:
- image: circleci/node:8.11.3-jessie
working_directory: ~/ext
steps:
- restore_cache:
key: build-{{ .Environment.CIRCLE_SHA1 }}
- run:
name: publish
command: |
yarn global add chrome-webstore-upload-cli
export PATH="$PATH:$HOME/.config/yarn/global/node_modules/.bin"
webstore upload --source dist.zip --extension-id $EXTENSION_ID
release:
docker:
- image: circleci/golang:1.9
steps:
- run:
key: download
command: wget "https://clients2.google.com/service/update2/crx?response=redirect&prodversion=49.0&x=id%3D${EXTENSION_ID}%26installsource%3Dondemand%26uc"
- run: go get github.com/tcnksm/ghr
- run:
name: release
command: |
ghr -t ${GITHUB_TOKEN} \
-u ${CIRCLE_PROJECT_USERNAME} \
-r ${CIRCLE_PROJECT_REPONAME} \
-c ${CIRCLE_SHA1} \
-delete \
${CIRCLE_TAG} ./
workflows:
version: 2
main:
jobs:
- install_dependencies
- build:
requires:
- install_dependencies
- publish:
requires:
- build
filters:
branches:
ignore: /.*/
tags:
only: /^v.*/
- release:
requires:
- publish
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,11 @@ better-onetab

More beatiful and more feature.

### Feature & Todo
### Features

[Send us a feature request.](https://github.com/cnwangjie/better-onetab/issues/new)

- [x] Basic functionality
- [x] Set title of list
- [x] Basic feature of onetab
- [x] Popup page with simple list
- [x] Pin tab list
- [x] Keyboard shortcuts
Expand All @@ -21,14 +20,23 @@ More beatiful and more feature.
- [x] Import & export
- [x] Add stored tabs to history
- [x] I18N support (only English & Chinese currently)
- [ ] Sync server (quotas provided by chrome are too less)

More details in [changelog](CHANGELOG.md)

### Next step

You can learn more about the next step of better onetab at [project page](https://github.com/cnwangjie/better-onetab/projects/1) and leave your comment in [issues page](https://github.com/cnwangjie/better-onetab/issues).

### Installation

Install from [Google Extension Store](https://chrome.google.com/webstore/detail/better-onetab/eookhngofldnbnidjlbkeecljkfpmfpg)

Install from [Firefox Add-ons](https://addons.mozilla.org/zh-CN/firefox/addon/better-onetab/) (not optimized)

Download the released .crx file in [release page](https://github.com/cnwangjie/better-onetab/releases) and drag it to chrome extensions page.

Build your own from following steps:

### Development

0. Clone this repo
Expand All @@ -39,4 +47,4 @@ Download the released .crx file in [release page](https://github.com/cnwangjie/b

### License

MIT LICENSE
MIT LICENSE
16 changes: 12 additions & 4 deletions README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ OneTab 的标签储存和标签分组功能是一个非常实用的功能,但

[想要更多功能?在这里告诉我吧](https://github.com/cnwangjie/better-onetab/issues/new)

- [x] 基本的标签储存分组功能
- [x] 设置标签列表的标题
- [x] Onetab中的所有基本功能
- [x] 弹出式的简易列表
- [x] 固定标签列表
- [x] 键盘快捷键
Expand All @@ -20,14 +19,23 @@ OneTab 的标签储存和标签分组功能是一个非常实用的功能,但
- [x] 导入及导出
- [x] 将储存的标签加入浏览器历史中
- [x] 国际化支持 (当前只有英语和中文)
- [ ] 同步服务器 (chrome 提供的同步配额太少了)

[changelog](./CHANGELOG.md) 中了解更多

### 更新计划

你可以从 [project page](https://github.com/cnwangjie/better-onetab/projects/1) 了解 better onetab 的更新动态,并且可以在 [issues page](https://github.com/cnwangjie/better-onetab/issues) 中留下你的意见。

### 安装

[Google 扩展商店](https://chrome.google.com/webstore/detail/better-onetab/eookhngofldnbnidjlbkeecljkfpmfpg) 安装。

[Firefox Add-ons](https://addons.mozilla.org/zh-CN/firefox/addon/better-onetab/) 安装 (尚未优化))

[release page](https://github.com/cnwangjie/better-onetab/releases) 下载 .crx 文件并将它拖拽至 chrome 的扩展管理页面。

从源码中编译:

### 开发

0. Clone 这个仓库
Expand All @@ -38,4 +46,4 @@ OneTab 的标签储存和标签分组功能是一个非常实用的功能,但

### 许可

MIT LICENSE
MIT LICENSE

0 comments on commit a6fe1bd

Please sign in to comment.