Skip to content

Commit 0adbee2

Browse files
author
sam
authored
chore: add README with instructions for installing (#1)
1 parent 9ff6304 commit 0adbee2

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,29 @@
1-
# replace this
1+
# Functionless Language Service Plugin
2+
3+
[![npm version](https://badge.fury.io/js/@functionless%2Flanguage-service.svg)](https://badge.fury.io/js/@functionless%2Flanguage-service)
4+
5+
The `@functionless/language-service` package configures a plugin for the TypeScript language service plugin that adds real-time errors to the IDE for [Functionless](https://github.com/functionless/functionless)'s semantic errors.
6+
7+
To configure, first install the module as a devDependency.
8+
9+
```shell
10+
# if using NPM
11+
npm install --save-dev @functionless/language-service
12+
13+
# if using yarn
14+
yarn add -D @functionless/language-service
15+
```
16+
17+
Then add as a plugin to your `tsconfig.json`.
18+
19+
```json
20+
{
21+
"compilerOptions": {
22+
"plugins": [
23+
{
24+
"name": "@functionless/language-service"
25+
}
26+
]
27+
}
28+
}
29+
```

0 commit comments

Comments
 (0)