Skip to content

Commit

Permalink
Add documentation and license
Browse files Browse the repository at this point in the history
  • Loading branch information
baincd committed Mar 7, 2021
1 parent 6c03bbf commit 5328dc9
Show file tree
Hide file tree
Showing 5 changed files with 86 additions and 56 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) [2021] [Chris Bain]

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.
109 changes: 57 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,70 @@
# diff-lang-improved README
# Diff Language (Improved)

This is the README for your extension "diff-lang-improved". After writing up a brief description, we recommend including the following sections.
diff-lang-improved provides enhancements to vscode diff language

## Features

Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
Add logical folding to Diff files

For example if there is an image subfolder under your extension project workspace:

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

> 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.
![example](example.png)

## 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.
This has been tested in vscode 1.50.1. It may work in earlier versions as well, but YMMV.

## Diff Colors Recommendation

This extension does *not* add/modify colorization of Diff files.

However, I do recommend adding the following to your settings.json (modifying the colors to your liking) to improve the colorization of Diff files. These colors work in both light and dark themes.

*This extension is not required for these settings to work. This is provided as a friendly suggestion to improve your diff language experience*

```json
"editor.tokenColorCustomizations": {
"textMateRules": [
// Colorize diff files
{
"scope": "meta.diff",
"settings": {
"fontStyle": "italic"
}
},
{
"scope": "meta.diff.header.git",
"settings": {
"foreground": "#ee8f00",
"fontStyle": "bold"
}
},
{
"scope": "meta.diff.index.git",
"settings": {
"foreground": "#999999"
}
},
{
"scope": "meta.diff.range.unified",
"settings": {
"foreground": "#ee8f00",
}
}
]
}
```

If you want to use different colors for different themes, this can be achieved by using the following:

```json
"editor.tokenColorCustomizations": {
"[THEME_NAME]": {
"textMateRules": [...]
}
}
```

## 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.

-----------------------------------------------------------------------------------------------------------

## 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 of Diff Language (Improved)
Binary file added example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 7 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
{
"publisher": "baincd",
"name": "diff-lang-improved",
"displayName": "diff-lang-improved",
"displayName": "Diff Language (Improved)",
"description": "Improvement on diff language",
"version": "0.0.1",
"version": "1.0.0",
"repository": {
"url": "https://github.com/baincd/vscode-diff-lang-improved"
},
"license": "MIT",
"engines": {
"vscode": "^1.54.0"
"vscode": "^1.50.0"
},
"categories": [
"Programming Languages"
Expand Down

0 comments on commit 5328dc9

Please sign in to comment.