Skip to content

Commit

Permalink
Add icon for extension
Browse files Browse the repository at this point in the history
  • Loading branch information
TranquilMarmot committed Jul 20, 2020
1 parent 8202fc1 commit 8dec3a3
Show file tree
Hide file tree
Showing 4 changed files with 96 additions and 10 deletions.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,9 @@ All scripts **must** be run at the root of the repo. Because of the way that Ler

### CI/CD

TODO Github Actions
Every pull request and merge to the `main` branch has the [`continuous-integration-worfkflow.yml`](./.github/workflows/continuous-integration-workflow.yml) run against it.

TODO: CD for automatic releases

### Packaging the extension

Expand Down
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
# Yarn Loom Visual Studio Code Extension

Yarn Loom is an editor for [yarn files](https://yarnspinner.dev/). It is a version of the [Yarn Editor](https://github.com/YarnSpinnerTool/YarnEditor) re-built from the ground up to integrate seamlessly with Visual Studio Code.
<p align="center">
<img src="./images/logo.svg" alt="Yarn Loom Logo" />
</p>

Yarn Loom is a Visual Studio Code extension for editing [yarn files](https://yarnspinner.dev/). It is a re-imagining of the [Yarn Editor](https://github.com/YarnSpinnerTool/YarnEditor) built from the ground up to integrate seamlessly with Visual Studio Code.

![demo video](./images/demo.gif)

- [Yarn Loom Visual Studio Code Extension](#yarn-loom-visual-studio-code-extension)
- [Installing](#installing)
- [Usage](#usage)
- [Reporting Issues/Bugs, Contributing, and Technical Details](#reporting-issuesbugs-contributing-and-technical-details)
- [How To](#how-to)
- [Editing nodes](#editing-nodes)
- [Renaming nodes](#renaming-nodes)
Expand All @@ -18,7 +23,6 @@ Yarn Loom is an editor for [yarn files](https://yarnspinner.dev/). It is a versi
- [Searching](#searching)
- [Quick tag search](#quick-tag-search)
- [Switching between the graph editor and a text editor](#switching-between-the-graph-editor-and-a-text-editor)
- [Contributing, Reporting Issues/Bugs, and Technical Details](#contributing-reporting-issuesbugs-and-technical-details)
- [Special Thanks](#special-thanks)

## Installing
Expand All @@ -30,6 +34,12 @@ Yarn Loom is an editor for [yarn files](https://yarnspinner.dev/). It is a versi

Once the extension is installed, simply open up a `.yarn` or a `.yarn.txt` file to use it!

## Reporting Issues/Bugs, Contributing, and Technical Details

If you find any issues or bugs with this extension, [please open up a new issue on the GitHub repo](https://github.com/TranquilMarmot/YarnLoom/issues/new/choose) and include as much detail as possible!

For in-depth technical details on how this extension works, and how to contribute to it yourself, see [CONTRIBUTING.md](./CONTRIBUTING.md).

## How To

Each of the examples below has an expandable gif that shows the editor in action.
Expand Down Expand Up @@ -95,7 +105,7 @@ You can also add new nodes by opening up the node list, scrolling to the bottom,

### Deleting nodes

Nodes can be deleted by clicking the garbage can/trash icon in the their title (![garbage can icon](./loom-editor.loom-editor/src/icons/trash.svg)). A confirmation message will be displayed.
Nodes can be deleted by clicking the garbage can/trash icon in the their title (![garbage can icon](./loom-editor/src/icons/trash.svg)) . A confirmation message will be displayed.

<details>
<summary>Expand for demo of deleting a node</summary>
Expand Down Expand Up @@ -135,12 +145,6 @@ In this menu, clicking the gear icon will set an editor as the default editor fo
<img src="./images/reopen-with-text-editor.gif" alt="Demo of switching between Yarn Loom and a text editor" />
</details>

## Contributing, Reporting Issues/Bugs, and Technical Details

If you find any issues or bugs with this extension, [please open up a new issue on the GitHub repo](https://github.com/TranquilMarmot/YarnLoom/issues/new/choose) and include as much detail as possible!

For juicy in-depth technical details for how this works, and how to contribute to it yourself, see [CONTRIBUTING.md](./CONTRIBUTING.md).

## Special Thanks

The syntax highlighting portion of this extension was copied over from the [Yarn VSCode Extension](https://github.com/YarnSpinnerTool/VSCodeExtension) and all credit for it goes to [@desplesda](https://github.com/desplesda).
Expand Down
Loading

0 comments on commit 8dec3a3

Please sign in to comment.