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

Commit

Permalink
v1.26.3
Browse files Browse the repository at this point in the history
  • Loading branch information
eejdoowad committed May 31, 2020
1 parent 55289a4 commit 83c0b9e
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 65 deletions.
45 changes: 13 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,10 @@
# Saka Key

Saka Key is a Chrome and Firefox extension for keyboard-only web browsing. It differs from existing extensions because
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).

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.

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.

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.

4. It's built with modern tools: ES6+, Webpack, Preact.

Saka Key lacks some features other extensions have today, but it has the foundation to reinvent and recreate them better than ever.

Try [Saka](https://saka.io), read the [Saka Key Handbook](https://key.saka.io), and ask questions on [Gitter](https://gitter.im/lusakasa/Lobby).

## Install

* **Chrome** - install from the [Chrome Web Store](https://chrome.google.com/webstore/detail/saka-key/hhhpdkekipnbloiiiiaokibebpdpakdp).
* **Firefox** - install from the [Firefox Marketplace](https://addons.mozilla.org/en-US/firefox/addon/saka-key/)
![Saka Key Preview](./docs/docs/assets/saka-key-preview.gif)

### Install from Source
### Install

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

Expand All @@ -28,27 +13,23 @@ git clone https://github.com/lusakasa/saka-key.git
cd saka-key
npm install
# Option 1. Chrome development build
npm run build:chrome
npm run start:chrome
# Option 2. Chrome production build
npm run build:chrome:prod
npm run build:chrome
# Option 3. Firefox development build
npm run build:firefox
npm run start:firefox
# Option 4. Firefox production build
npm run build:firefox:prod
npm run build:firefox
```

## Preview

![Saka Key Preview](./docs/docs/assets/saka-key-preview.gif)

## Credits

MIT Licensed, Copyright (c) 2018 Sufyan Dawoodjee, Neil Macintyre
MIT Licensed, Copyright (c) 2018 Sufyan Dawoodjee, Neil Macintyre, Brandon Kalinowski

Saka Key is inspired by and derives from

* [Vimium](https://github.com/philc/vimium)
* [Vimari](https://github.com/guyht/vimari)
* [cVim](https://github.com/1995eaton/chromium-vim)
* [Surfingkeys](https://github.com/brookhong/Surfingkeys)
* [VimFX](https://github.com/akhodakivskiy/VimFx)
- [Vimium](https://github.com/philc/vimium)
- [Vimari](https://github.com/guyht/vimari)
- [cVim](https://github.com/1995eaton/chromium-vim)
- [Surfingkeys](https://github.com/brookhong/Surfingkeys)
- [VimFX](https://github.com/akhodakivskiy/VimFx)
4 changes: 4 additions & 0 deletions docs/docs/about/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: Release Notes
sidebar_label: Release Notes
---

# 1.26.3

- Update Readme and handbooks

# 1.26.2

- Update build and release process
Expand Down
60 changes: 28 additions & 32 deletions docs/docs/developers/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,25 @@ sidebar_label: Setup

To develop Saka Key, you must first install:

* [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
* [Node.js and npm](https://nodejs.org/en/)
* 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.
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- [Node.js and npm](https://nodejs.org/en/)
- 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.

## Install

### Install on Chrome

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

```sh
git clone https://github.com/lusakasa/saka-key.git
cd saka-key
npm install
npm run build:chrome
# or if you want to generate an optimized production build
npm run build:chrome:prod
```
```sh
git clone https://github.com/lusakasa/saka-key.git
cd saka-key
npm install
npm run start:chrome
# or if you want to generate an optimized production build
npm run build:chrome
```

2. Navigate to `chrome://extensions`

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

### Install on Firefox

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

```sh
git clone https://github.com/lusakasa/saka-key.git
cd saka-key
npm install
npm run build:firefox
# or if you want to generate an optimized production build
npm run build:firefox:prod
```
```sh
git clone https://github.com/lusakasa/saka-key.git
cd saka-key
npm install
npm run start:firefox
# or if you want to generate an optimized production build
npm run build:firefox
```

2. Navigate to `about:debugging`

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

Saka Key is developed together with:

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

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

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

### Documentation Handbook (key.saka.io)

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.

[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/).

## Deployment

[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`.
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`.

[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/).

### Testing

This is unfortunately a todo.
This is unfortunately a todo.
2 changes: 1 addition & 1 deletion manifest/common.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "Saka Key",
"version": "1.26.2",
"version": "1.26.3",
"author": "Brandon Kalinowski, Sufyan Dawoodjee, Neil Macintyre",
"description": "A keyboard interface to the web",
"manifest_version": 2,
Expand Down

0 comments on commit 83c0b9e

Please sign in to comment.