Skip to content

Commit a84431b

Browse files
authored
📄 Update README.md
1 parent bacb839 commit a84431b

File tree

1 file changed

+50
-2
lines changed

1 file changed

+50
-2
lines changed

README.md

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,55 @@
1-
# Create Issue 2x faster with Command Linear
1+
# Create Issue 2x faster with Command Linear (Beta)
22

33
<p align="center">
44
<img src="https://github.com/castroCrea/commandLinear/assets/20707343/241c78f5-33d1-4d9c-965a-1d08472dcdd6" width="200px"/>
55
</p>
66

7-
Check out the roadmap here https://github.com/castroCrea/commandLinear/discussions/1
7+
Check out the 🛣️ roadmap here https://github.com/castroCrea/commandLinear/discussions/1
8+
9+
## ✨ Main caracterics
10+
11+
- Available where ever you are on the app
12+
- Use your favorite tool for screen recording or screenshot than open command linear we will propose you captured media
13+
- Easy to access shortcut
14+
- Preset parameters and followers
15+
16+
## Table of content
17+
18+
- ⚠️ [Warning](https://github.com/castroCrea/commandLinear/edit/main/README.md#%EF%B8%8F-warning)
19+
- 👨‍💻 [Onbaording](https://github.com/castroCrea/commandLinear/edit/main/README.md#-onboarding)
20+
- ℹ️ [Tips](https://github.com/castroCrea/commandLinear/edit/main/README.md#-onboarding)
21+
22+
## ⚠️ Warning
23+
24+
Command Linear as been develop on Mac OS and only been tested on make OS. We build version for Linux and Widnows. We will iterate on it if used.
25+
26+
<strong>This app is in Beta:</strong> All your issues are backed up locally to ensure you don't lose anything. You can open the backup from the menu.
27+
28+
## 👨‍💻 Onboarding
29+
30+
How to find my Linear API Key
31+
32+
In Linear go to `Perference` > `API` > `Generate API Key`
33+
You can name the key "Command Linear" and click generate
34+
35+
### Perference
36+
<img width="260" alt="image" src="https://github.com/castroCrea/commandLinear/assets/20707343/89c6efdb-608b-4a83-9a8e-c4cf51537561">
37+
38+
### API
39+
<img width="263" alt="image" src="https://github.com/castroCrea/commandLinear/assets/20707343/854f902f-f2c3-4bba-8cd9-53b0316e6487">
40+
41+
### Generate API Key
42+
<img width="724" alt="image" src="https://github.com/castroCrea/commandLinear/assets/20707343/58ca4055-6e33-490a-ab50-a60024fb0eea">
43+
44+
## ℹ️ Tips
45+
46+
- A notification show up after a capture, you can click on it to open directly Linear
47+
48+
<img width="357" alt="image" src="https://github.com/castroCrea/commandLinear/assets/20707343/1f285560-536b-4cb0-b369-d6670b16af2d">
49+
50+
- <strong>Use your Linear Templates:</strong> Use the `/` key to access templates.
51+
- Press the `Tab` key to move to the next element.
52+
- Hit the `Esc` key to hide content while keeping it available.
53+
- Hover over each element to discover its associated shortcut.
54+
55+

0 commit comments

Comments
 (0)