nyanotech/recombobulator
1
0
Fork 0
mirror of https://github.com/nyanotech/recombobulator synced 2025-12-16 03:20:22 -08:00
Code Issues Packages Projects Releases Wiki Activity

Add CHANGELOG and README

Browse Source
This commit is contained in:
nyanotech 2022-03-23 11:53:37 +00:00
parent f724c38f04
commit ddb39041c9
Signed by: nyanotech
GPG Key ID: D2D0A9E8F160472B
2 changed files with 14 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CHANGELOG.md
View File

@ -1,9 +1,7 @@
# Change Log
All notable changes to the "recombobulator" extension will be documented in this file.
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
## [Unreleased]
- Initial release
* Initial release
* rot13
* base64 encode/decode

70
README.md
View File

@ -1,70 +1,22 @@
# recombobulator README
# recombobulator
This is the README for your extension "recombobulator". After writing up a brief description, we recommend including the following sections.
This extension adds various text functions and encodings.
## Features
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
Currently available functions:
For example if there is an image subfolder under your extension project workspace:
* (un)base64
* rot13
\!\[feature X\]\(images/feature-x.png\)
This extension should properly support these vscode features:
> 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.
## Requirements
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
## 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.
* virtual workspaces
* untrusted workspaces
* multiple selections/cursors
## Release Notes
Users appreciate release notes as you update your extension.
### 0.0.1
### 1.0.0
Initial release of ...
### 1.0.1
Fixed issue #.
### 1.1.0
Added features X, Y, and Z.
-----------------------------------------------------------------------------------------------------------
## 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
**Note:** 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) or `Cmd+Space` (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/)
**Enjoy!**
* Initial release