Skip to content

Commit 05c193d

Browse files
committed
docs(README): update readme
1 parent bf757c3 commit 05c193d

File tree

3 files changed

+42
-2
lines changed

3 files changed

+42
-2
lines changed

README.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,42 @@
1-
# jetbrains-angular1-snippets
2-
JetBrains Angular 1 + ngMetadata Typescript snippets
1+
# Angular 1 + ngMetadata Typescript Snippets for JetBrains products
2+
3+
This Live Template Group for JetBrains products adds snippets for Angular 1 with [ng-metadata](https://github.com/ngParty/ng-metadata) for TypeScript.
4+
5+
> based on [@johnpapa](https://twitter.com/John_Papa) [vsCode snippets](https://github.com/johnpapa/vscode-angular2-snippets).
6+
7+
> create component
8+
9+
![Use Extension](images/use-extension-component.gif)
10+
11+
> create Module
12+
13+
![Use Extension](images/use-extension-module.gif)
14+
15+
## Usage
16+
Type part of a snippet, press `tab`, and the snippet unfolds.
17+
18+
## TypeScript Snippets
19+
```
20+
ng-bootstrap
21+
ng-component
22+
ng-directive
23+
ng-pipe
24+
ng-service
25+
ng-module
26+
ng-provide-d
27+
ng-provide-s
28+
ng-provide-st
29+
ng-provide-p
30+
ng-provide-c
31+
ng-provide-v
32+
```
33+
34+
Alternatively, press `Ctrl+J` (Windows, Linux) or `Cmd+J` (OSX) to activate snippets from within the editor.
35+
36+
37+
38+
## Installation
39+
There are two ways to do this:
40+
41+
- Store a copy of the `Angular1-ngMetadata-Snippets.xml` file in the corresponding [templates](https://www.jetbrains.com/help/idea/2016.1/live-templates.html) folder.
42+
- Follow the [instructions](https://www.jetbrains.com/help/idea/2016.1/sharing-live-templates.html) under **To paste the live templates**

images/use-extension-component.gif

143 KB
Loading

images/use-extension-module.gif

516 KB
Loading

0 commit comments

Comments
 (0)