Skip to content

Commit 7e373a9

Browse files
committed
doc: write docs
1 parent c169a78 commit 7e373a9

File tree

2 files changed

+8
-58
lines changed

2 files changed

+8
-58
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,6 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
66

77
## [Unreleased]
88

9+
## [0.0.4] - 2022-05-13
10+
911
- Initial release

README.md

Lines changed: 6 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -2,75 +2,23 @@
22

33
View code ownership information within your favorite editor!
44

5-
![feature X](images/hero.gif)
5+
![Code Ownership](./images/hero.gif)
66

77
## Features
88

9-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
9+
View code ownership for every file right in the status bar. You'll the the name of the owning team in the status bar or an alert showing that the file is unowned.
1010

11-
For example if there is an image subfolder under your extension project workspace:
12-
13-
\!\[feature X\]\(images/feature-x.png\)
14-
15-
> 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.
11+
Quick access to the owning teams config file. Clicking on the status bar item will open a popup that includes a button that opens the team's config file. See [Big Rails Teams](https://github.com/bigrails/bigrails-teams) for more information on team config files.
1612

1713
## Requirements
1814

19-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
20-
21-
## Extension Settings
22-
23-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
24-
25-
For example:
26-
27-
This extension contributes the following settings:
28-
29-
- `myExtension.enable`: enable/disable this extension
30-
- `myExtension.thing`: set to `blah` to do something
31-
32-
## Known Issues
33-
34-
Calling out known issues can help limit users opening duplicate issues against your extension.
15+
This extension runs the [CodeOwnership](https://github.com/bigrails/code_ownership) CLI. You'll need to install and configure [CodeOwnership](https://github.com/bigrails/code_ownership) in your repository before using this extension. (Before it's setup, you'll see `Owner: error!` in the status bar.)
3516

3617
## Release Notes
3718

38-
Users appreciate release notes as you update your extension.
39-
40-
### 1.0.0
41-
42-
Initial release of ...
43-
44-
### 1.0.1
45-
46-
Fixed issue #.
47-
48-
### 1.1.0
49-
50-
Added features X, Y, and Z.
51-
52-
---
53-
54-
## Following extension guidelines
55-
56-
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
57-
58-
- [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
59-
60-
## Working with Markdown
61-
62-
**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
63-
64-
- Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
65-
- Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
66-
- Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets
67-
68-
### For more information
69-
70-
- [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
71-
- [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
19+
### 0.0.4 - 2022-05-13
7220

73-
**Enjoy!**
21+
- Initial release
7422

7523
---
7624

0 commit comments

Comments
 (0)