Skip to content
This repository was archived by the owner on Oct 6, 2021. It is now read-only.

Commit 2b50d5b

Browse files
committed
TASK: add license file, improve snippets table, add keywords & contributors
1 parent 22f3a10 commit 2b50d5b

File tree

3 files changed

+35
-11
lines changed

3 files changed

+35
-11
lines changed

LICENSE

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
MIT License
2+
3+
Copyright (c) 2018 Sandstorm Media GmbH
4+
5+
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:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
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.

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,23 @@ Fully Typed:
1616
- defaultProps
1717
- state
1818
- defaultState
19-
- test
20-
- storybook
19+
- React component test
20+
- React component storybook
2121
- React Redux container
2222
- mapStateToProps
2323
- mapDispatchToProps
2424

25-
## Usage
26-
In `*.ts` files:
27-
* `store` - Type safe Redux store.
25+
## Snippets
2826

29-
In `*.tsx` files:
30-
* `component` - Type safe PureComponent.
31-
* `container` - Type safe container component.
32-
* `story` - Type safe story for Storybook.
33-
* `test` - Type safe component test.
27+
Below is a list of all available snippets and the triggers of each one. The **** means the `TAB` key.
28+
29+
| Trigger | Content |
30+
| -------: | ------- |
31+
| `component→` | `Type safe PureComponent` |
32+
| `story→`| `Type safe story for Storybook` |
33+
| `test→`| `Type safe component test` |
34+
| `container→` | `Type safe container component` |
35+
| `store→` | `Type safe Redux store` |
3436

3537
## Example (Component with defaultProps)
3638

@@ -57,6 +59,9 @@ export type PickDefaultProps<Props, defaultPropsKeys extends keyof Props> = Read
5759

5860
* Redux-Saga does not work with `'@@martin_hotell/rex-tils'`'s action creator. You can fix this by not using Redux-Saga or by unfreezing your actions for Redux-Saga. (https://github.com/Hotell/rex-tils/issues/21)
5961

62+
## License
63+
MIT
64+
6065
## Release Notes
6166

6267
Users appreciate release notes as you update your extension.

package.json

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
"author": {
88
"name": "Sandstorm Media"
99
},
10+
"contributors": [
11+
"Robert Baruck (@JamesAlias)"
12+
],
1013
"license": "MIT",
1114
"homepage": "https://github.com/sandstorm/vscode-awesome-ts-react-redux-snippets",
1215
"repository": {
@@ -31,5 +34,12 @@
3134
"path": "./snippets/typescriptreact.snippets.json"
3235
}
3336
]
34-
}
37+
},
38+
"keywords": [
39+
"typescript",
40+
"react",
41+
"redux",
42+
"vscode",
43+
"snippets"
44+
]
3545
}

0 commit comments

Comments
 (0)