Skip to content

Commit

Permalink
enhance: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hackjutsu committed May 5, 2019
1 parent 99367e4 commit b6ce9d3
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 14 deletions.
33 changes: 19 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,23 @@
- Unlimited public/private snippets
- Unlimited tags
- Language groups
- Markdown support
- Jupyter Notebook viewer support
- macOS/Win/Linux support
- Markdown/JupyterNotebook support
- GitHub Enterprise support
- Immersive mode
- Customizable
- Light/Dark theme
- macOS/Win/Linux
- Dashboard
- Search
- Proxy
- Free

![Screenshot](./docs/img/portfolio/stay_organized.png)

| Light Theme | Dark Theme |
| :-------------:| :-----:|
|![Screenshot](./docs/img/portfolio/lepton-light.png)|![Screenshot](./docs/img/portfolio/lepton-dark.png)|

| Organize | Markdown | Jupyter Notebook |
| :-------------:| :-----:| :-----: |
| ![Screenshot](./docs/img/portfolio/stay_organized.png) | ![Screenshot](./docs/img/portfolio/markdown.png) | ![Screenshot](./docs/img/portfolio/jupyterNotebook.png)
Expand All @@ -48,6 +52,18 @@
| About Page | `Cmd/Ctrl + ,` | Toggle the [About page](https://github.com/hackjutsu/Lepton/blob/dev/docs/img/portfolio/about.png) |
| Search | `Shift + Space`| Toggle the [search bar](https://github.com/hackjutsu/Lepton/blob/master/docs/img/portfolio/search_bar.png) |

## Cutomization
Lepton can be costomized by `<home_dir>/.leptonrc` in the these fields. (Create the file if it does not exist.)

- Theme (light/dark)
- Snippet
- Editor
- Logger
- Proxy
- Enterprise

Check out the [.leptonrc template](https://gist.github.com/1ad7e4968eb64d881ec9dedd6c0f400b) to explore different customization options.

## Tech Stack
![Based on](./docs/img/erb-logo.png)

Expand Down Expand Up @@ -114,17 +130,6 @@ Build apps for the current OS with the current arch.
$ npm run dist
```

## Configurations
Lepton can be configured by `<home_dir>/.leptonrc` in the these fields. (Create the file if it does not exist.)

- Snippet
- Editor
- Logger
- Proxy
- Enterprise

Check out the [.leptonrc template](https://gist.github.com/1ad7e4968eb64d881ec9dedd6c0f400b) to explore their options.

## FAQ
[--> Wiki FAQ](https://github.com/hackjutsu/Lepton/wiki/FAQ)

Expand Down
Binary file added docs/img/portfolio/lepton-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/portfolio/lepton-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b6ce9d3

Please sign in to comment.