Skip to content

Commit

Permalink
Enhanced the Readme with Images and Emojis.
Browse files Browse the repository at this point in the history
  • Loading branch information
Hyperclaw79 committed Jun 13, 2022
1 parent 4e0cc53 commit 6a86a20
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 14 deletions.
45 changes: 31 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,32 +8,43 @@ So you'd want to write them down somewhere.\
What better way to do that than to use **Sticky Notes** right?! \
Now you don't need to maintain them externally, with <big>**VSSticky**</big>, you can attach sticky notes from within VSCode!

## Why VSSticky? :memo:
## Why VSSticky? 📝
There are tons of sticky notes extensions out there, but what makes <big>**VSSticky**</big> different?\
<big>**VSSticky**</big> is a first of a kind extension that offers isolated sticky notes.\
You can have `seperate sticky notes for every file`.
> You can focus better on the task at hand.\
> No more the need for scavenging through a bunch of sticky notes to find the one that you had planned for a particular file.
[<img src="./assets/vssticky_preview.gif" width="50%">](./assets/vssticky_preview.gif)
[<img src="./assets/vssticky_preview.gif" width="75%">](./assets/vssticky_preview.gif)

## Features
## Features 📖

* Add Persistent Sticky Notes for every file.
* **Notes Panel**
* Add Persistent Sticky Notes for every file.

* Create Ephemeral (temporary) Sticky Notes which auto-delete on file change.
[<img src="./assets/NotePerFile.gif" width="50%">](./assets/NotePerFile.gif)

* The Sticky Note is a Markdown editor that you can double click to edit.
> It support emojis, checkboxes and images as well.
* Create Ephemeral (temporary) Sticky Notes which auto-delete on file change.

* Set unique color for every Sticky Note.
[<img src="./assets/EphemeralNote.gif" width="50%">](./assets/EphemeralNote.gif)

* The Sticky Note is a Markdown editor that you can double click to edit.
> It support emojis, checkboxes and images as well.
[<img src="./assets/MarkdownNote.gif" width="80%">](./assets/MarkdownNote.gif)

* Set unique color for every Sticky Note.

[<img src="./assets/ColorNote.gif" width="50%">](./assets/ColorNote.gif)

* **All Sticky Notes Webview**
> A consolidated sticky notes view in the Explorer for all files.
* Auto-refreshes when a sticky note is added, updated or removed.
* Double Click on a Sticky Note to jump to file.

## Installation
[<img src="./assets/AllNotesView.gif" width="40%">](./assets/AllNotesView.gif)

## Installation 🛠

To install <big>**VSSticky**</big>, you have three options:
1. Search for `VSSticky` in the Extensions panel on VS Code.
Expand All @@ -42,14 +53,14 @@ To install <big>**VSSticky**</big>, you have three options:
[![Visual Studio Marketplace Version](https://img.shields.io/github/package-json/v/hyperclaw79/vssticky?label=VSSticky&logo=Visual%20Studio%20Code&logoColor=blue&style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=Hyperclaw79.vssticky)


## Extension Settings
## Extension Settings

<big>**VSSticky**</big> exposes one User Setting:

* `vssticky.autosaveInterval`: This is the time in milliseconds between each autosave for a sticky note. Defaults to 500.
* `vssticky.autosaveInterval`: This is the time in milliseconds between each autosave for a sticky note. Defaults to `500`.


## Commands
## Commands 🤖

Following are the commands that you can use in the VSCode context menu.

Expand All @@ -61,10 +72,16 @@ Command | Description
`Delete All Notes` | Delete all created Sticky Notes.


## Contribution
## Tips 💡

1. Use colors to group your sticky notes. For e.g., by Project, Bugs/Features, etc.
2. Double click on a sticky note to quickly jump to the file.
3. Check out the [Markdown Cheat Sheet](https://www.markdownguide.org/cheat-sheet/).

## Contribution 💬

Please read the [Contribution Guide](./CONTRIBUTING.md) to help improve VSSticky.

## Release Notes
## Release Notes 📰

Please read the [release notes](./CHANGELOG.md) to learn about the latest changes.
Binary file added assets/AllNotesView.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/ColorNote.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/EphemeralNote.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/MarkdownNote.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/NotePerFile.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6a86a20

Please sign in to comment.