Skip to content

Commit

Permalink
Update to v2 formatting and 1.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
JustinWoodring committed Dec 30, 2022
1 parent 2e221b0 commit 5ebd489
Show file tree
Hide file tree
Showing 19 changed files with 946 additions and 173 deletions.
3 changes: 3 additions & 0 deletions .vscodeignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,6 @@ vsc-extension-quickstart.md
**/.eslintrc.json
**/*.map
**/*.ts
**/extension.js
**/types
**/test
6 changes: 2 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

All notable changes to the "capibara" extension will be documented in this file.

Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
## [1.0.0] - 2022-12-30

## [Unreleased]

- Initial release
- Initial release
7 changes: 7 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copyright 2022 Justin Woodring

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
56 changes: 12 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,39 @@
# capibara README

This is the README for your extension "capibara". After writing up a brief description, we recommend including the following sections.
capibara-vs-code is the visual studio code plugin for using Capibara documentation.

## Features
![Hover-based Documentation](images/capibara.gif)

Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
## Features

For example if there is an image subfolder under your extension project workspace:
- Hover documentation based on the the crowd-sourced C library definitions contributed to Capibara.
- Custom definitions file URL setting for ease of debugging, hosting, and maintaining your own documentation.

\!\[feature X\]\(images/feature-x.png\)
## Commands

> 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.
Documentation is hover activated. You can manually trigger a redownload of the documentation via the `capibara.fetchLatestDefinitions` command.
Presented as Capibara: Fetch Latest Definitions.

## Requirements

If you have any requirements or dependencies, add a section describing those and how to install and configure them.
This extension utilizes the vscode file downloader extension. You should be prompted upon plugin initialization to install this.

## Extension Settings

Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.

For example:

This extension contributes the following settings:

* `myExtension.enable`: Enable/disable this extension.
* `myExtension.thing`: Set to `blah` to do something.

## Known Issues

Calling out known issues can help limit users opening duplicate issues against your extension.
- `capibara.definitionsFileURL`: This is the URL that capibara will use to download definitions.

## Release Notes

Users appreciate release notes as you update your extension.

### 1.0.0

Initial release of ...

### 1.0.1

Fixed issue #.

### 1.1.0

Added features X, Y, and Z.
Initial release of capibara-vs-code.

---

## Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)

## Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.

## For more information

* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
- [Capibara](https://capibara.tools/)

**Enjoy!**
Binary file added images/capibara.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 5ebd489

Please sign in to comment.