Skip to content
This repository was archived by the owner on Nov 7, 2022. It is now read-only.

Commit 83c0b9e

Browse files
eejdoowadeejdoowad
committed
v1.26.3
1 parent 55289a4 commit 83c0b9e

File tree

4 files changed

+46
-65
lines changed

4 files changed

+46
-65
lines changed

‎README.md

+13-32
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,10 @@
11
# Saka Key
22

3-
Saka Key is a Chrome and Firefox extension for keyboard-only web browsing. It differs from existing extensions because
3+
Saka Key is a Chrome and Firefox extension for keyboard-only web browsing. It's configurable, easy to use, and engineered thoughtfully. Install it from the [Chrome Web Store](https://chrome.google.com/webstore/detail/saka-key/hhhpdkekipnbloiiiiaokibebpdpakdp) or the [Firefox Marketplace](https://addons.mozilla.org/en-US/firefox/addon/saka-key/). Also read the [Saka Key Handbook](https://key.saka.io) and try the accompanying tab search extension [Saka](https://github.com/lusakasa/saka).
44

5-
1. Its state machine [architecture](https://key.saka.io/docs/developers/software-architecture) is modular, extensible, and **SIMPLE**. Its design is inspired by my frustration trying to make sense of the scattered state, confusing event handling, and dubious design of similar extensions.
6-
7-
2. It's not Vim. Aesthetics matter and graphical menus takes preference over text configuration. It's friendly to non-developers. You shouldn't need a tutorial, but there is one.
8-
9-
3. It's engineered for configurability. Developers define options with JSON. This JSON is used to generate the Options Page. Changes to options automatically propagate to all tabs. Options are organized into _profiles_, which are easy to switch between. Sensible default profiles are built-in. Options can be exported and imported.
10-
11-
4. It's built with modern tools: ES6+, Webpack, Preact.
12-
13-
Saka Key lacks some features other extensions have today, but it has the foundation to reinvent and recreate them better than ever.
14-
15-
Try [Saka](https://saka.io), read the [Saka Key Handbook](https://key.saka.io), and ask questions on [Gitter](https://gitter.im/lusakasa/Lobby).
16-
17-
## Install
18-
19-
* **Chrome** - install from the [Chrome Web Store](https://chrome.google.com/webstore/detail/saka-key/hhhpdkekipnbloiiiiaokibebpdpakdp).
20-
* **Firefox** - install from the [Firefox Marketplace](https://addons.mozilla.org/en-US/firefox/addon/saka-key/)
5+
![Saka Key Preview](./docs/docs/assets/saka-key-preview.gif)
216

22-
### Install from Source
7+
### Install
238

249
Follow the [Development Setup Guide](https://key.saka.io/docs/developers/setup.html) for detailed instructions. Otherwise:
2510

@@ -28,27 +13,23 @@ git clone https://github.com/lusakasa/saka-key.git
2813
cd saka-key
2914
npm install
3015
# Option 1. Chrome development build
31-
npm run build:chrome
16+
npm run start:chrome
3217
# Option 2. Chrome production build
33-
npm run build:chrome:prod
18+
npm run build:chrome
3419
# Option 3. Firefox development build
35-
npm run build:firefox
20+
npm run start:firefox
3621
# Option 4. Firefox production build
37-
npm run build:firefox:prod
22+
npm run build:firefox
3823
```
3924

40-
## Preview
41-
42-
![Saka Key Preview](./docs/docs/assets/saka-key-preview.gif)
43-
4425
## Credits
4526

46-
MIT Licensed, Copyright (c) 2018 Sufyan Dawoodjee, Neil Macintyre
27+
MIT Licensed, Copyright (c) 2018 Sufyan Dawoodjee, Neil Macintyre, Brandon Kalinowski
4728

4829
Saka Key is inspired by and derives from
4930

50-
* [Vimium](https://github.com/philc/vimium)
51-
* [Vimari](https://github.com/guyht/vimari)
52-
* [cVim](https://github.com/1995eaton/chromium-vim)
53-
* [Surfingkeys](https://github.com/brookhong/Surfingkeys)
54-
* [VimFX](https://github.com/akhodakivskiy/VimFx)
31+
- [Vimium](https://github.com/philc/vimium)
32+
- [Vimari](https://github.com/guyht/vimari)
33+
- [cVim](https://github.com/1995eaton/chromium-vim)
34+
- [Surfingkeys](https://github.com/brookhong/Surfingkeys)
35+
- [VimFX](https://github.com/akhodakivskiy/VimFx)

‎docs/docs/about/release-notes.md

+4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ title: Release Notes
44
sidebar_label: Release Notes
55
---
66

7+
# 1.26.3
8+
9+
- Update Readme and handbooks
10+
711
# 1.26.2
812

913
- Update build and release process

‎docs/docs/developers/setup.md

+28-32
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,25 @@ sidebar_label: Setup
88

99
To develop Saka Key, you must first install:
1010

11-
* [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
12-
* [Node.js and npm](https://nodejs.org/en/)
13-
* A text editor. I recommend [VS Code](https://code.visualstudio.com/Download) with the [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) extensions.
11+
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
12+
- [Node.js and npm](https://nodejs.org/en/)
13+
- A text editor. I recommend [VS Code](https://code.visualstudio.com/Download) with the [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) extensions.
1414

1515
## Install
1616

1717
### Install on Chrome
1818

19-
1. Run the following commands in your terminal to clone and build Saka Key.
20-
An extension you can run will be generated in the 'dist' directory.
19+
1. Run the following commands in your terminal to clone and build Saka Key.
20+
An extension you can run will be generated in the 'dist' directory.
2121

22-
```sh
23-
git clone https://github.com/lusakasa/saka-key.git
24-
cd saka-key
25-
npm install
26-
npm run build:chrome
27-
# or if you want to generate an optimized production build
28-
npm run build:chrome:prod
29-
```
22+
```sh
23+
git clone https://github.com/lusakasa/saka-key.git
24+
cd saka-key
25+
npm install
26+
npm run start:chrome
27+
# or if you want to generate an optimized production build
28+
npm run build:chrome
29+
```
3030

3131
2. Navigate to `chrome://extensions`
3232

@@ -38,17 +38,17 @@ To develop Saka Key, you must first install:
3838

3939
### Install on Firefox
4040

41-
1. Run the following commands in your terminal to clone and build Saka Key.
42-
An extension you can run will be generated in the 'dist' directory.
41+
1. Run the following commands in your terminal to clone and build Saka Key.
42+
An extension you can run will be generated in the 'dist' directory.
4343

44-
```sh
45-
git clone https://github.com/lusakasa/saka-key.git
46-
cd saka-key
47-
npm install
48-
npm run build:firefox
49-
# or if you want to generate an optimized production build
50-
npm run build:firefox:prod
51-
```
44+
```sh
45+
git clone https://github.com/lusakasa/saka-key.git
46+
cd saka-key
47+
npm install
48+
npm run start:firefox
49+
# or if you want to generate an optimized production build
50+
npm run build:firefox
51+
```
5252

5353
2. Navigate to `about:debugging`
5454

@@ -62,7 +62,7 @@ To develop Saka Key, you must first install:
6262

6363
Saka Key is developed together with:
6464

65-
* Mosi - a messaging library for Chrome extensions: [github](https://github.com/eejdoowad/mosi), [npm](https://www.npmjs.com/package/mosi)
65+
- Mosi - a messaging library for Chrome extensions: [github](https://github.com/eejdoowad/mosi), [npm](https://www.npmjs.com/package/mosi)
6666

6767
You may have to debug or modify Mosi when contributing to saka key. To use your local copy of Mosi when building Saka Key:
6868

@@ -71,16 +71,12 @@ You may have to debug or modify Mosi when contributing to saka key. To use your
7171
3. Navigate to the root of Saka key.
7272
4. Run `npm link mosi`
7373

74-
### Documentation Handbook (key.saka.io)
75-
76-
The Saka Key handbook (which you're reading right now) is generated using [Gitbook](https://github.com/GitbookIO/gitbook). Markdown files in the `book` directory are processed by Gitbook to generate HTML files. Run `npn run book:dev` from Saka Key's root directory to see changes live.
77-
78-
[key.saka.io](https://key.saka.io) is automataically generated from Saka Key's github repository on every commit using [Netlify](https://www.netlify.com/).
79-
8074
## Deployment
8175

82-
[Travis CI](https://travis-ci.org/) generates a [Saka Key Release](https://github.com/lusakasa/saka-key/releases) from every tagged commit. A release includes source code as well as development and production builds for Chrome and Firefox. Create a release with `git tag -a v1.x.x -m "v1.x.x"`. Push tags with `git push origin --tags`.
76+
A Github action generates a release from every tagged commit. To generate a new release, run `git tag vx.x.x"`. Then push the tag with`git push origin vx.x.x`.
77+
78+
[key.saka.io](https://key.saka.io) is automataically generated from `/docs` directory of Saka Key's github repository on every commit using [Netlify](https://www.netlify.com/).
8379

8480
### Testing
8581

86-
This is unfortunately a todo.
82+
This is unfortunately a todo.

‎manifest/common.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "Saka Key",
3-
"version": "1.26.2",
3+
"version": "1.26.3",
44
"author": "Brandon Kalinowski, Sufyan Dawoodjee, Neil Macintyre",
55
"description": "A keyboard interface to the web",
66
"manifest_version": 2,

0 commit comments

Comments
 (0)