Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update readme and some packages #594

Merged
merged 2 commits into from
Sep 11, 2022
Merged

chore: update readme and some packages #594

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7598b6
chore: update readme and json package
ogustavo-pereira Sep 10, 2022
ed45724
chore: bump package version and update some packages
ogustavo-pereira Sep 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
141 changes: 36 additions & 105 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Cerebro

> Cerebro is a open-source launcher to improve your productivity and efficiency

<img src="./build/icons/128x128.png" align="right"/>

## Usage
Expand All @@ -10,7 +12,7 @@ After installation use default shortcut `ctrl+space` to show an app window. You

![Cerebro](https://cloud.githubusercontent.com/assets/594298/20180624/858a483a-a75b-11e6-94a1-ef1edc4d95c3.gif)

## Plugins
### Plugins

### Core plugins

Expand All @@ -28,29 +30,13 @@ Cerebro provides several shortcuts to improve your productivity:
* `ctrl+1...9`: select directly a result from the list
* `ctrl+[hjkl]`: navigate through the results using vim-like keys (Also `ctrl+o` to select the result)

### Install and manage custom plugins

Use built-in `plugins` command to search and manage custom plugins.

Discover plugins and more at [Cerebro's Awesome List](https://github.com/lubien/awesome-cerebro).

You can install them manually using npm

open it in the terminal configuration file path, go to the plugins folder

```bash
cd ./plugins
```

Install the plugin
### Change Theme

```bash
npm install --save name-of-plugin
```
Use shortcut `ctrl+space` to open app window and type `Cerebro Settings`. There you will be able to change the Theme (Currently Light and Dark Themes are supported out of the box)

### Create plugin
![change-cerebro-theme](https://user-images.githubusercontent.com/24854406/56137765-5880ca00-5fb7-11e9-86d0-e740de1127c2.gif)

Check out [plugins documentation](./docs/plugins.md).
## For developers

### Install

Expand Down Expand Up @@ -80,29 +66,39 @@ yarn run dev

> Note: requires a node version >=16.x

### Build executable from source
### Install and manage custom plugins

If you would like to install one version but the package is not published you can use this command to build executable file from source:
Use built-in `plugins` command to search and manage custom plugins.

Discover plugins and more at [Cerebro's Awesome List](https://github.com/lubien/awesome-cerebro).

You can install them manually using npm

open it in the terminal configuration file path, go to the plugins folder

```bash
yarn package
cd ./plugins
```

> Note: in CI we use `yarn build` as there is an action to package and publish the executables
Install the plugin

### Resolve common issues
```bash
npm install --save name-of-plugin
```

1. `AssertionError: Current node version is not supported for development` on npm postinstall.
After `yarn` postinstall script checks node version. If you see this error you have to check node and npm version in `package.json` `devEngines` section and install proper ones.
## Create plugin

2. `Uncaught Error: Module version mismatch. Exepcted 50, got ...`
This error means that node modules with native extensions build with wrong node version (your local node version != node version, included to electron). To fix this issue run `cd ./app && yarn run rebuild`
Check out [plugins documentation](./docs/plugins.md).

### Change Theme
### Build executable from source

Use shortcut `ctrl+space` to open app window and type `Cerebro Settings`. There you will be able to change the Theme (Currently Light and Dark Themes are supported out of the box)
If you would like to install one version but the package is not published you can use this command to build executable file from source:

![change-cerebro-theme](https://user-images.githubusercontent.com/24854406/56137765-5880ca00-5fb7-11e9-86d0-e740de1127c2.gif)
```bash
yarn package
```

> Note: in CI we use `yarn build` as there is an action to package and publish the executables

#### Config file path

Expand All @@ -112,7 +108,13 @@ Use shortcut `ctrl+space` to open app window and type `Cerebro Settings`. There

*macOS*: `~/Library/Application Support/Cerebro/config.json`

## For developers
### Resolve common issues

1. `AssertionError: Current node version is not supported for development` on npm postinstall.
After `yarn` postinstall script checks node version. If you see this error you have to check node and npm version in `package.json` `devEngines` section and install proper ones.

2. `Uncaught Error: Module version mismatch. Exepcted 50, got ...`
This error means that node modules with native extensions build with wrong node version (your local node version != node version, included to electron). To fix this issue run `cd ./app && yarn run rebuild`

### Conventional Commit Format

Expand All @@ -135,77 +137,6 @@ CerebroApp is using GH actions to build the app and publish it to a release. To

CerebroApp was created from an [old version of electron-react-boilerplate](https://github.com/cerebroapp/cerebro/commit/57b6e28c0f64beae8948cf17f099fa5d6236ae3c) and uses a two package.json file structure. If you are interested in developing a new feature, you should read about this structure in the [electron-react-boilerplate documentation](https://www.electron.build/tutorials/two-package-structure.html).

# Support

### Backers

Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/cerebro#backer)]

<a href="https://opencollective.com/cerebro/backer/0/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/0/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/1/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/1/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/2/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/2/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/3/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/3/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/4/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/4/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/5/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/5/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/6/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/6/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/7/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/7/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/8/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/8/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/9/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/9/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/10/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/10/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/11/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/11/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/12/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/12/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/13/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/13/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/14/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/14/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/15/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/15/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/16/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/16/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/17/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/17/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/18/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/18/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/19/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/19/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/20/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/20/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/21/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/21/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/22/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/22/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/23/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/23/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/24/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/24/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/25/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/25/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/26/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/26/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/27/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/27/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/28/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/28/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/backer/29/website" target="_blank"><img src="https://opencollective.com/cerebro/backer/29/avatar.svg"></a>

### Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/cerebro#sponsor)]

<a href="https://opencollective.com/cerebro/sponsor/0/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/1/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/2/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/3/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/4/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/5/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/6/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/7/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/8/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/9/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/9/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/10/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/10/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/11/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/11/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/12/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/12/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/13/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/13/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/14/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/14/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/15/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/15/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/16/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/16/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/17/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/17/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/18/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/18/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/19/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/19/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/20/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/20/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/21/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/21/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/22/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/22/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/23/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/23/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/24/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/24/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/25/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/25/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/26/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/26/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/27/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/27/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/28/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/28/avatar.svg"></a>
<a href="https://opencollective.com/cerebro/sponsor/29/website" target="_blank"><img src="https://opencollective.com/cerebro/sponsor/29/avatar.svg"></a>

## License

Expand Down
10 changes: 5 additions & 5 deletions app/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
"main": "./main.js",
ogustavo-pereira marked this conversation as resolved.
Show resolved Hide resolved
"license": "MIT",
"author": {
"name": "Alexandr Subbotin",
"email": "kelionweb@gmail.com",
"url": "https://github.com/KELiON"
"name": "CerebroApp Organization",
"url": "https://github.com/cerebroapp"
},
"contributors": [
"Gustavo Pereira",
"David Jiménez"
"Alexandr Subbotin <kelionweb@gmail.com> (https://github.com/KELiON)",
"Gustavo Pereira <oguhpereira@protonmail.com (https://github.com/oguhpereira)",
"David Jiménez <dubisdev@gmail.com> (https://dubis.dev)"
],
"dependencies": {
"move-file": "2.1.0",
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "cerebro",
"productName": "cerebro",
"version": "0.6.0",
"version": "0.7.0",
ogustavo-pereira marked this conversation as resolved.
Show resolved Hide resolved
"description": "Cerebro is an open-source launcher to improve your productivity and efficiency",
"main": "main.js",
"scripts": {
Expand Down Expand Up @@ -33,7 +33,7 @@
},
"contributors": [
"Alexandr Subbotin <kelionweb@gmail.com> (https://github.com/KELiON)",
"Gustavo Pereira",
"Gustavo Pereira <oguhpereira@protonmail.com (https://github.com/oguhpereira)",
"David Jiménez <dubisdev@gmail.com> (https://dubis.dev)"
],
"license": "MIT",
Expand Down