From 4f9f4ee8f40b18df0a38d5267d760f0710fadfd4 Mon Sep 17 00:00:00 2001 From: Thierry Delafontaine Date: Wed, 22 Feb 2023 14:19:57 +0100 Subject: [PATCH] docs: update the info in the readme --- README.md | 49 ++++--------------------------------------------- 1 file changed, 4 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index 77158a8..8b6e396 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ This repo contains a collection of ZHAW related snippets. ## Features -Currently, this collection provides snippets for the InES file headers in C/C++ -and VHDL. More snippets will be added when they get requested or I when I -encounter them. +| Snippet | Purpose | Available in | +| ------- | -------------------- | ---------------------------------------- | +| `inesh` | The InES file header | c, cpp, vhdl, latex, python, shellscript | ## Installation @@ -52,12 +52,6 @@ require("luasnip.loaders.from_vscode").load() require("luasnip.loaders.from_vscode").lazy_load() ``` -## Snippets - -| Snippet | Purpose | Available in | -| ------- | -------------------- | ---------------------------------------- | -| `inesh` | The InES file header | c, cpp, vhdl, latex, python, shellscript | - ## Resources - [VSCode Snippets Documentation](https://code.visualstudio.com/docs/editor/userdefinedsnippets) @@ -66,39 +60,4 @@ require("luasnip.loaders.from_vscode").lazy_load() ## Release Notes -Users appreciate release notes as you update your extension. - -### 1.0.0 - -- Initial release of zhaw-snippets - -### 1.0.1 - -- Added header snippet for latex -- Moved to yarn - -### 1.0.2 - -- Fixed latex header snippet - -### 1.0.3 - -- Added header snippet for python -- Added header snippet for shell -- Added at least one empty line after the header insertion. - -### 1.0.4 - -- Removed angle brackets from python header snippets -- Updated readme - -### 1.0.5 - -- Updated the python header, to match common usage -- Standardized the header over all file types - -### 1.0.6 - -- fix(python): moved one-line docstring onto the same line as the double quotes - (PEP257) -- fix(python): added space after '=' symbol +See [CHANGELOG](CHANGELOG.md) for details.