Skip to content

Commit bc7d9f7

Browse files
committed
update docs
1 parent 0566d39 commit bc7d9f7

File tree

3 files changed

+65
-2
lines changed

3 files changed

+65
-2
lines changed

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Change Log
2+
3+
All notable changes to the "ecs-vscode" extension will be documented in this file.
4+
5+
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
6+
7+
## [0.1.0]
8+
9+
- Initial release

README.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,55 @@
1-
# Elastic Common Schema support for Visual Studio Code
1+
# ecs-vscode
2+
3+
A set of YAML snippets for working with the [Elastic Common Schema (ECS)](https://www.elastic.co/guide/en/ecs/current/ecs-reference.html) field definitions.
4+
5+
## Elastic Common Schema support for Visual Studio Code
6+
7+
A collection of YAML snippets for faster development of ECS field definitions in [Visual Studio Code](https://code.visualstudio.com/). See the VSCode [docs](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_creating-your-own-snippets) for more detail around creating code snippets.
8+
9+
## Snippets
10+
11+
### New ECS Field
12+
13+
```yaml
14+
- name: $1
15+
level: ${2:extended}
16+
type: ${3:keyword}
17+
short: $4
18+
description: >
19+
$5
20+
example: $6
21+
```
22+
23+
### New ECS field set
24+
25+
```yaml
26+
---
27+
- name: ${1:$TM_FILENAME_BASE}
28+
title: $2
29+
group: ${3:2}
30+
short: $4
31+
description: >
32+
$5
33+
type: ${6:group}
34+
35+
fields:
36+
37+
- name: $7
38+
level: ${8:extended}
39+
type: ${9:keyword}
40+
short: $10
41+
description: >
42+
$11
43+
example: $12
44+
```
45+
46+
### Reusable configuration
47+
48+
```yaml
49+
reusable:
50+
top_level: ${1:true}
51+
expected:
52+
- at: $2
53+
as: ${3:$TM_FILENAME_BASE}
54+
55+
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "ecs-vscode",
33
"displayName": "ecs-vscode",
44
"description": "",
5-
"version": "0.0.1",
5+
"version": "0.1.0",
66
"engines": {
77
"vscode": "^1.59.0"
88
},

0 commit comments

Comments
 (0)