Skip to content

Commit

Permalink
add README, LICENSE and cleanup
Browse files Browse the repository at this point in the history
Signed-off-by: Shubh <shubhisroking@proton.me>
  • Loading branch information
shubhisroking committed Sep 1, 2023
1 parent 8f4f182 commit b839f82
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 110 deletions.
9 changes: 0 additions & 9 deletions CHANGELOG.md

This file was deleted.

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) 2023 Shubh

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.
74 changes: 15 additions & 59 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,27 @@
# vscode-streamer-mode README
# VSCode Streamer Mode

This is the README for your extension "vscode-streamer-mode". After writing up a brief description, we recommend including the following sections.
This extension adds a "Streamer Mode" feature to Visual Studio Code that helps prevent accidental sharing of sensitive information while streaming or recording your screen.

## Features

Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
- Toggles streamer mode on and off with a single click
- Blocks opening of sensitive files while streamer mode is enabled
- Shows a warning message when attempting to open a sensitive file
- Allows opening of sensitive files with a confirmation prompt

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

\!\[feature X\]\(images/feature-x.png\)
To enable streamer mode, click on the "Streamer Mode: Disabled" status bar item. This will toggle streamer mode on and off.

> 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.
When streamer mode is enabled, attempting to open a sensitive file will show a warning message. You can choose to open the file anyway with a confirmation prompt.

## Requirements
## Configuration

If you have any requirements or dependencies, add a section describing those and how to install and configure them.
This extension provides the following configuration options:

## Extension Settings
- `vscode-streamer-mode.enabled`: Whether streamer mode is enabled or not. Default is `false`.
- `vscode-streamer-mode.sensitiveFileExtensions`: An array of file extensions that are considered sensitive. Default is `["env", "local", "development", "staging", "production", "test", "pem", "key", "cer", "crt", "p12", "pfx"]`.

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

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.

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

---

## 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/)

**Enjoy!**
This extension is licensed under the [MIT License](LICENSE).
42 changes: 0 additions & 42 deletions vsc-extension-quickstart.md

This file was deleted.

0 comments on commit b839f82

Please sign in to comment.