Improved readme and Added Contributing and license documents

CHANGELOG.md

@@ -4,6 +4,24 @@ All notable changes to the "snippetify" extension will be documented in this fil
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
-## [1.0.0]
+## 1.1.0 - 14th Jully, 2020
+
+### Enhancement
+
+- Improved the readme documentation
+- Added Contributing and license documents
+
+## 1.0.1 - 13th Jully, 2020
+
+### Enhancement
+
+- Added new logo
+- Added production api url
+
+### Fixed
+
+- Fixed some bugs
+
+## 1.0.0 - 13th Jully, 2020
 
 - Initial release

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+Please read and understand the contribution guide before creating an issue or pull request.
+
+## Etiquette
+
+This project is open source, and as such, the maintainers give their free time to build and maintain the source code held within. They make the code freely available in the hope that it will be of use to other developers. It would be extremely unfair for them to suffer abuse or anger for their hard work.
+
+Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the world that developers are civilized and selfless people.
+
+It's the duty of the maintainer to ensure that all submissions to the project are of sufficient quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
+
+## Viability
+
+When requesting or submitting new features, first consider whether it might be useful to others. Open source projects are used by many developers, who may have entirely different needs to your own. Think about whether or not your feature is likely to be used by other users of the project.
+
+## Procedure
+
+Before filing an issue:
+
+- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
+- Check to make sure your feature suggestion isn't already present within the project.
+- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
+- Check the pull requests tab to ensure that the feature isn't already in progress.
+
+Before submitting a pull request:
+
+- Check the codebase to ensure that your feature doesn't already exist.
+- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
+
+## Requirements
+
+If the project maintainer has any additional requirements, you will find them listed here.
+
+- The easiest way to apply the conventions is to install [Eslint](https://eslint.org/)
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+**Happy coding**!

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Snippetify LLC
+
+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.

README.md

@@ -1,65 +1,165 @@
-# Snippetify
+# Snippetify for Visual Studio Code
 
-This extension enables you to create snippets from editor code and quickly insert snippets from Snippetify warehouse. With Intellisense out of the box.
+This extension enables you to save snippets to the cloud from editor code and quickly insert any snippets from **Snippetify** warehouse, with *Intellisense* out of the box.
 
-## Features
+## About Snippetify
 
-Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
+![banner](/Applications/MAMP/htdocs/plugins/ide/vscode/media/banner.png)
 
-For example if there is an image subfolder under your extension project workspace:
+Snippetify is a community snippets warehouse but also a suite of tools that allow you to exploit these snippets.
 
-\!\[feature X\]\(images/feature-x.png\)
+- Save your snippets to the cloud
+- Search snippets
+- Deep searching (search for snippets all over the web)
+- Share your snippets
+- Embed snippets in your forum or blog
+- Organize your snippets with tags
+- Contribute on snippets of others
+- Enhance your snippets by receiving votes and comments
+- Make coding fun by challenging your friends
+- Work on your notoriety by publishing good snippets which will allow you to receive stars, badges and privileges
 
-> 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.
+## Snippetify Extension Features
+
+1. Search snippets in the cloud
+
+ 1. Pre-fill with your document language
+ 2. Search in any user repository
+ 3. Search in your repository
+ 4. Search by tags
+
+2. Quickly insert snippets in one click
+
+3. Snippet preview with documentation
+
+4. Save your snippets to the cloud
+
+ 1. Pre-fill form
+ 1. With your document title
+ 2. With your document language
+ 3. With your selected code
+
+5. Snippet collections
+
+ 1. Save cloud snippet locally to your collections
+ 2. Download your snippets
+ 3. Download your favorites snippets
+
+ Intellisense
+
+ 1. Snippet suggestion when typing
+
+<img src="/Applications/MAMP/htdocs/plugins/ide/vscode/media/tour.gif" alt="tour" style="zoom:80%;float:left;" />
 
 ## Requirements
 
-If you have any requirements or dependencies, add a section describing those and how to install and configure them.
+This Extension is available for free but registration is required for saving snippets to the cloud.
 
-## Extension Settings
+## Getting started
 
-Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
+#### 1. Install the Snippetify extension
 
-For example:
+<img src="/Applications/MAMP/htdocs/plugins/ide/vscode/media/install.gif" alt="install" style="zoom:80%;float:left;" />
 
-This extension contributes the following settings:
+#### 2. Add your Personal Access Token
 
-* `myExtension.enable`: enable/disable this extension
-* `myExtension.thing`: set to `blah` to do something
+##### 1. Get your token [https://snippetify.com/settings/account/tokens](https://snippetify.com/settings/account/tokens)
 
-## Known Issues
+<img src="/Applications/MAMP/htdocs/plugins/ide/vscode/media/token.gif" alt="token" style="zoom:80%;float:left;" />
 
-Calling out known issues can help limit users opening duplicate issues against your extension.
+##### 2. Add it to **Preferences > Settings > Extensions > Snippetify**
 
-## Release Notes
+<img src="/Applications/MAMP/htdocs/plugins/ide/vscode/media/add_token.gif" alt="add_token" style="zoom:80%;float:left;" />
 
-Users appreciate release notes as you update your extension.
+You're all set! You can start saving snippets
 
-### 1.0.0
+## Commands
 
-Initial release of ...
+### Snippetify: Search snippets
 
-### 1.0.1
+> Shortcut: ctrl+alt+f
 
-Fixed issue #.
+Search for and insert a snippet from your or community repositories. Searches across snippets' title, description, tags and content.
 
-### 1.1.0
+### Snippetify: Save selection
 
-Added features X, Y, and Z.
+> Shortcut: ctrl+alt+s
 
------------------------------------------------------------------------------------------------------------
+Save a snippet to the cloud from the text selection. The command launch a form which will allow you to add information about your snippet.
+
+### Snippetify: Close Panel
+
+> Shortcut: ctrl+alt+c
+
+Close Snippetify panel.
+
+### Snippetify: Refresh collection
+
+Refresh your local snippets collection.
+
+### Snippetify: Delete collection
+
+Delete your local snippets collection.
+
+### Snippetify: Download my snippets
+
+Download your personal snippets.
+
+### Snippetify: Remove my snippets from collection
+
+Delete your personal snippets from local collection.
+
+### Snippetify: Download my favorites snippets
 
-## Working with Markdown
+Download your favorites snippets.
 
-**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
+### Snippetify: Remove my favorites snippets from collection
 
-* 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
+Delete your favorite snippets from local collection
+
+## Context Menu
+
+Right-click on an active editor to bring up Snippetify context menu actions. You can **Save Snippet** from the selected text or **Insert Snippet** at the cursor position.
+
+<img src="/Applications/MAMP/htdocs/plugins/ide/vscode/media/context_menu.png" alt="context_menu" style="zoom:25%;float:left;" />
+
+## Status Bar Item
+
+Click on **</> Snippets** in the VSCode footer to launch **Snippetify** finder which lets you search for snippets in the cloud.
+
+<img src="/Applications/MAMP/htdocs/plugins/ide/vscode/media/status_bar.png" alt="status_bar" style="zoom:50%;float:left;" />
+
+## Change Keyboard Shortcuts
+
+Snippetify's default shortcuts can be configured via the Keyboard Shortcuts editor (**Preferences > Keyboard Shortcuts**).
+
+## Extension Settings
+
+Change Snippetify's default behavior (**Preferences > Settings > Extensions > Snippetify**).
+
+This extension contributes the following settings:
+
+* `snippetify.token`: set your personal access token
+
+<img src="/Applications/MAMP/htdocs/plugins/ide/vscode/media/settings.png" alt="settings" style="zoom:50%;float:left;" />
+
+## Ask for help
+
+If you're having issues with this extension, please reach out to us by [filing an issue](https://github.com/snippetify/vs-code/issues).
+
+Take a look at [snippetify.com/help](https://snippetify.com/help) for additional guidance.
+
+## [Contributing](https://github.com/snippetify/vs-code/blob/master/CONTRIBUTING.md)
+
+We welcome your contributions and thank you for working to improve the Snippetify development experience in VS Code. If you would like to help work on the VS Code Snippetify extension, please see our [contribution guide](https://github.com/snippetify/vs-code/blob/master/CONTRIBUTING.md). It explains how to build and run the extension locally, and it describes the process of sending a contribution.
+
+-----------------------------------------------------------------------------------------------------------
+
+## [License](https://github.com/snippetify/vs-code/blob/master/LICENSE)
+
+* [MIT](https://github.com/snippetify/vs-code/blob/master/LICENSE)
 
-### 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!**
+

package.json

@@ -193,7 +193,7 @@
  "snippetify.token": {
  "type": "string",
  "scope": "application",
- "markdownDescription": "Your identification token. The link [Token](https://snippetify.com)"
+ "markdownDescription": "Your Personal Access Token. The link [Token](https://snippetify.com/settings/account/tokens)"
  }
  }
  }

src/TreeViewManager.ts

@@ -90,7 +90,7 @@ export default class TreeViewManager {
 
  private createStatusBarItem () {
  this.statusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, 0);
- this.statusBarItem.text = 'Snippetify';
+ this.statusBarItem.text = '$(code) Snippetify';
  this.statusBarItem.command = WebviewManager.SEARCH_PANEL_CMD;
  this.statusBarItem.tooltip = 'Show Snippetify commands';
  this.ctx.subscriptions.push(this.statusBarItem);