Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #2

Merged
merged 1 commit into from
Oct 28, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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) 2020 Avenga Germany GmbH

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.
35 changes: 19 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
# Couper Configuration Extension for Visual Studio Code
# Couper Configuration for Visual Studio Code
This extension adds Couper-specific highlighting and autocompletion to [Couper's configuartion file](https://github.com/avenga/couper/tree/master/docs#conf_file) couper.hcl in Visual Studio Code.
## Features
### Attributes and Blocks
Select from all Couper-specific attributes and blocks.
![](images/selection.png)
![](images/attribute.png)
### Types and Values
Automatically choose the right type or value for Couper-specific attributes.
![](images/list.png)
### Handy Configuration
Easy input for mandatory labels. The cursor jumps directly to the necessary spot.
![](images/label.png)
## Setup
make install
## About Couper
[Couper](https://github.com/avenga/couper) is a frontend gateway especially designed to support building and running API-driven Web projects. Acting as a proxy component it connects clients with (micro) services and adds access control and observability to the project.

### Features

Select from couper specific suggestions like blocks, attributes and variables based on your document context.
Jump directly to the necessary label or value spots.

![](images/example.gif)

### Development

To test or improve this extension you can start with `make run` within your working directory.

### About Couper
[Couper](https://github.com/avenga/couper) is a frontend gateway especially designed to support building and running API-driven Web projects. Acting as a proxy component it connects clients with (micro) services and adds access control and observability to the project.

### [License](LICENSE)

[MIT](LICENSE)
Binary file removed images/attribute.png
Binary file not shown.
Binary file added images/example.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 removed images/label.png
Binary file not shown.
Binary file removed images/list.png
Binary file not shown.
Binary file removed images/selection.png
Binary file not shown.