Skip to content

Commit 94bcbd3

Browse files
committed
start of a proper readme
1 parent 2e192df commit 94bcbd3

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,31 @@
11
# eps-cdk-utils
2+
3+
This contains a docker image used to deploy cdk to our environments and a cdk-constructs library
4+
5+
# cdk-constructs
6+
7+
This contains common cdk constructs used in eps projects
8+
9+
Available constructs are
10+
11+
- TypescriptLambdaFunction
12+
13+
# development
14+
15+
If you want to test a new construct, add it to packages/cdkConstructs
16+
Run the following to produce a distributable tarball
17+
```
18+
make package
19+
```
20+
This will produce a tarball file in lib folder
21+
22+
Copy this to the project you want to use it in and use the following to install it
23+
24+
```
25+
npm install --save NHSDigital-eps-cdk-constructs-1.0.0.tgz --workspace packages/cdk/
26+
```
27+
28+
You will then be able to use it - eg
29+
```
30+
import {TypescriptLambdaFunction} from "@NHSDigital/eps-cdk-constructs"
31+
```

0 commit comments

Comments
 (0)