Let your editor cheer you on while you code!
docs(readme): add real content
+18
-45
+18
-45
README.md
+18
-45
README.md
···
1
-
# vscode-cheer README
1
+
# Cheer!
2
2
3
-
This is the README for your extension "vscode-cheer". After writing up a brief description, we recommend including the following sections.
3
+
> Let your editor cheer you on while you code!
4
4
5
5
## Features
6
6
7
-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
7
+
Code editors can often be a source of negativity — undefined `this`, unsupported `that`, expected `x` to be of type `y` — it gets tiring after a while. And you can't always rely on your coworkers (if you even have any) for moral support in the moment, since they also have jobs to do. How is a programmer supposed to stay positive?
8
8
9
-
For example if there is an image subfolder under your extension project workspace:
9
+
The solution: Cheer!
10
10
11
-
\!\[feature X\]\(images/feature-x.png\)
11
+
Cheer displays a random positive message in the status bar whenever you save a file. That's it. That's all it does — give it a try, and feel better about your day and your work!
12
12
13
-
> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
13
+
Inspired by an Atom extension I used many years ago, and couldn't manage to track down again.
14
14
15
-
## Requirements
15
+
## Screenshots
16
16
17
-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
17
+
18
+
19
+
20
+
18
21
19
-
## Extension Settings
22
+
## Contributing
20
23
21
-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
24
+
I'd love any contributions to Cheer, especially new messages to display! If you find any bugs or have any suggestions, either open an issue, or open a PR with the messages added to `messages.js`.
22
25
23
-
For example:
26
+
All messages are parsed and validated by [Alex](https://alexjs.com) so we can keep Cheer as inclusive as possible.
24
27
25
-
This extension contributes the following settings:
28
+
## Extension Settings
26
29
27
-
* `myExtension.enable`: enable/disable this extension
28
-
* `myExtension.thing`: set to `blah` to do something
30
+
- `cheer.emoji`: Whether to 🎉 or not
29
31
30
32
## Known Issues
31
33
32
-
Calling out known issues can help limit users opening duplicate issues against your extension.
34
+
Nothing so far! I'd love if you found some.
33
35
34
36
## Release Notes
35
37
36
-
Users appreciate release notes as you update your extension.
37
-
38
-
### 1.0.0
39
-
40
-
Initial release of ...
41
-
42
-
### 1.0.1
43
-
44
-
Fixed issue #.
45
-
46
-
### 1.1.0
47
-
48
-
Added features X, Y, and Z.
49
-
50
-
-----------------------------------------------------------------------------------------------------------
51
-
52
-
## Working with Markdown
53
-
54
-
**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
55
-
56
-
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
57
-
* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
58
-
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets
59
-
60
-
### For more information
61
-
62
-
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
63
-
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
64
-
65
-
**Enjoy!**
38
+
Check in the [changelog](CHANGELOG.md) for info!