Skip to content

Commit 74bc06b

Browse files
mattsb42-awsmattsb42-aws
authored
add readme templates (#90)
1 parent 81c22ab commit 74bc06b

File tree

20 files changed

+472
-0
lines changed

20 files changed

+472
-0
lines changed

‎modules/cache-material/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# aws-encryption-sdk-javascript
2+
3+
The AWS Encryption SDK for JavaScript is a client-side encryption library designed to make it easy for everyone to encrypt and decrypt data using industry standards and best practices. It uses a data format compatible with the AWS Encryption SDKs in other languages. For more information on the AWS Encryption SDKs in all languages, see the [Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html).
4+
5+
## About <packagename>
6+
7+
This packages is not intended for direct use by clients. To get started with the AWS Encryption SDK for JavaScript, follow the instructions in [the README](https://github.com/awslabs/aws-encryption-sdk-javascript/blob/master/README.md).
8+
9+
## License
10+
11+
This SDK is distributed under the
12+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
13+
see LICENSE.txt and NOTICE.txt for more information.
14+

‎modules/caching-materials-manager-browser/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# aws-encryption-sdk-javascript
2+
3+
The AWS Encryption SDK for JavaScript is a client-side encryption library designed to make it easy for everyone to encrypt and decrypt data using industry standards and best practices. It uses a data format compatible with the AWS Encryption SDKs in other languages. For more information on the AWS Encryption SDKs in all languages, see the [Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html).
4+
5+
## Installing
6+
7+
### In the browser
8+
9+
<instructions go here>
10+
11+
### In Node.JS
12+
13+
<instructions go here>
14+
15+
## Testing
16+
17+
### With npm
18+
19+
<instructions go here>
20+
21+
### Integration packages
22+
23+
<instructions go here>
24+
25+
## License
26+
27+
This SDK is distributed under the
28+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
29+
see LICENSE.txt and NOTICE.txt for more information.
30+

‎modules/caching-materials-manager-node/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# aws-encryption-sdk-javascript
2+
3+
The AWS Encryption SDK for JavaScript is a client-side encryption library designed to make it easy for everyone to encrypt and decrypt data using industry standards and best practices. It uses a data format compatible with the AWS Encryption SDKs in other languages. For more information on the AWS Encryption SDKs in all languages, see the [Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html).
4+
5+
## Installing
6+
7+
### In the browser
8+
9+
<instructions go here>
10+
11+
### In Node.JS
12+
13+
<instructions go here>
14+
15+
## Testing
16+
17+
### With npm
18+
19+
<instructions go here>
20+
21+
### Integration packages
22+
23+
<instructions go here>
24+
25+
## License
26+
27+
This SDK is distributed under the
28+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
29+
see LICENSE.txt and NOTICE.txt for more information.
30+

‎modules/decrypt-browser/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# aws-encryption-sdk-javascript
2+
3+
The AWS Encryption SDK for JavaScript is a client-side encryption library designed to make it easy for everyone to encrypt and decrypt data using industry standards and best practices. It uses a data format compatible with the AWS Encryption SDKs in other languages. For more information on the AWS Encryption SDKs in all languages, see the [Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html).
4+
5+
## Installing
6+
7+
### In the browser
8+
9+
<instructions go here>
10+
11+
### In Node.JS
12+
13+
<instructions go here>
14+
15+
## Testing
16+
17+
### With npm
18+
19+
<instructions go here>
20+
21+
### Integration packages
22+
23+
<instructions go here>
24+
25+
## License
26+
27+
This SDK is distributed under the
28+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
29+
see LICENSE.txt and NOTICE.txt for more information.
30+

‎modules/decrypt-node/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# aws-encryption-sdk-javascript
2+
3+
The AWS Encryption SDK for JavaScript is a client-side encryption library designed to make it easy for everyone to encrypt and decrypt data using industry standards and best practices. It uses a data format compatible with the AWS Encryption SDKs in other languages. For more information on the AWS Encryption SDKs in all languages, see the [Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html).
4+
5+
## Installing
6+
7+
### In the browser
8+
9+
<instructions go here>
10+
11+
### In Node.JS
12+
13+
<instructions go here>
14+
15+
## Testing
16+
17+
### With npm
18+
19+
<instructions go here>
20+
21+
### Integration packages
22+
23+
<instructions go here>
24+
25+
## License
26+
27+
This SDK is distributed under the
28+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
29+
see LICENSE.txt and NOTICE.txt for more information.
30+

‎modules/encrypt-browser/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# aws-encryption-sdk-javascript
2+
3+
The AWS Encryption SDK for JavaScript is a client-side encryption library designed to make it easy for everyone to encrypt and decrypt data using industry standards and best practices. It uses a data format compatible with the AWS Encryption SDKs in other languages. For more information on the AWS Encryption SDKs in all languages, see the [Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html).
4+
5+
## Installing
6+
7+
### In the browser
8+
9+
<instructions go here>
10+
11+
### In Node.JS
12+
13+
<instructions go here>
14+
15+
## Testing
16+
17+
### With npm
18+
19+
<instructions go here>
20+
21+
### Integration packages
22+
23+
<instructions go here>
24+
25+
## License
26+
27+
This SDK is distributed under the
28+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
29+
see LICENSE.txt and NOTICE.txt for more information.
30+

‎modules/encrypt-node/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# aws-encryption-sdk-javascript
2+
3+
The AWS Encryption SDK for JavaScript is a client-side encryption library designed to make it easy for everyone to encrypt and decrypt data using industry standards and best practices. It uses a data format compatible with the AWS Encryption SDKs in other languages. For more information on the AWS Encryption SDKs in all languages, see the [Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html).
4+
5+
## Installing
6+
7+
### In the browser
8+
9+
<instructions go here>
10+
11+
### In Node.JS
12+
13+
<instructions go here>
14+
15+
## Testing
16+
17+
### With npm
18+
19+
<instructions go here>
20+
21+
### Integration packages
22+
23+
<instructions go here>
24+
25+
## License
26+
27+
This SDK is distributed under the
28+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
29+
see LICENSE.txt and NOTICE.txt for more information.
30+

‎modules/kms-keyring-browser/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# aws-encryption-sdk-javascript
2+
3+
The AWS Encryption SDK for JavaScript is a client-side encryption library designed to make it easy for everyone to encrypt and decrypt data using industry standards and best practices. It uses a data format compatible with the AWS Encryption SDKs in other languages. For more information on the AWS Encryption SDKs in all languages, see the [Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html).
4+
5+
## Installing
6+
7+
### In the browser
8+
9+
<instructions go here>
10+
11+
### In Node.JS
12+
13+
<instructions go here>
14+
15+
## Testing
16+
17+
### With npm
18+
19+
<instructions go here>
20+
21+
### Integration packages
22+
23+
<instructions go here>
24+
25+
## License
26+
27+
This SDK is distributed under the
28+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
29+
see LICENSE.txt and NOTICE.txt for more information.
30+

‎modules/kms-keyring-node/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# aws-encryption-sdk-javascript
2+
3+
The AWS Encryption SDK for JavaScript is a client-side encryption library designed to make it easy for everyone to encrypt and decrypt data using industry standards and best practices. It uses a data format compatible with the AWS Encryption SDKs in other languages. For more information on the AWS Encryption SDKs in all languages, see the [Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html).
4+
5+
## Installing
6+
7+
### In the browser
8+
9+
<instructions go here>
10+
11+
### In Node.JS
12+
13+
<instructions go here>
14+
15+
## Testing
16+
17+
### With npm
18+
19+
<instructions go here>
20+
21+
### Integration packages
22+
23+
<instructions go here>
24+
25+
## License
26+
27+
This SDK is distributed under the
28+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
29+
see LICENSE.txt and NOTICE.txt for more information.
30+

‎modules/kms-keyring/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# aws-encryption-sdk-javascript
2+
3+
The AWS Encryption SDK for JavaScript is a client-side encryption library designed to make it easy for everyone to encrypt and decrypt data using industry standards and best practices. It uses a data format compatible with the AWS Encryption SDKs in other languages. For more information on the AWS Encryption SDKs in all languages, see the [Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html).
4+
5+
## About <packagename>
6+
7+
This packages is not intended for direct use by clients. To get started with the AWS Encryption SDK for JavaScript, follow the instructions in [the README](https://github.com/awslabs/aws-encryption-sdk-javascript/blob/master/README.md).
8+
9+
## License
10+
11+
This SDK is distributed under the
12+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
13+
see LICENSE.txt and NOTICE.txt for more information.
14+

‎modules/material-management-browser/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# aws-encryption-sdk-javascript
2+
3+
The AWS Encryption SDK for JavaScript is a client-side encryption library designed to make it easy for everyone to encrypt and decrypt data using industry standards and best practices. It uses a data format compatible with the AWS Encryption SDKs in other languages. For more information on the AWS Encryption SDKs in all languages, see the [Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html).
4+
5+
## About <packagename>
6+
7+
This packages is not intended for direct use by clients. To get started with the AWS Encryption SDK for JavaScript, follow the instructions in [the README](https://github.com/awslabs/aws-encryption-sdk-javascript/blob/master/README.md).
8+
9+
## License
10+
11+
This SDK is distributed under the
12+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
13+
see LICENSE.txt and NOTICE.txt for more information.
14+

‎modules/material-management-node/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# aws-encryption-sdk-javascript
2+
3+
The AWS Encryption SDK for JavaScript is a client-side encryption library designed to make it easy for everyone to encrypt and decrypt data using industry standards and best practices. It uses a data format compatible with the AWS Encryption SDKs in other languages. For more information on the AWS Encryption SDKs in all languages, see the [Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html).
4+
5+
## About <packagename>
6+
7+
This packages is not intended for direct use by clients. To get started with the AWS Encryption SDK for JavaScript, follow the instructions in [the README](https://github.com/awslabs/aws-encryption-sdk-javascript/blob/master/README.md).
8+
9+
## License
10+
11+
This SDK is distributed under the
12+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
13+
see LICENSE.txt and NOTICE.txt for more information.
14+

‎modules/material-management/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# aws-encryption-sdk-javascript
2+
3+
The AWS Encryption SDK for JavaScript is a client-side encryption library designed to make it easy for everyone to encrypt and decrypt data using industry standards and best practices. It uses a data format compatible with the AWS Encryption SDKs in other languages. For more information on the AWS Encryption SDKs in all languages, see the [Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html).
4+
5+
## About <packagename>
6+
7+
This packages is not intended for direct use by clients. To get started with the AWS Encryption SDK for JavaScript, follow the instructions in [the README](https://github.com/awslabs/aws-encryption-sdk-javascript/blob/master/README.md).
8+
9+
## License
10+
11+
This SDK is distributed under the
12+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
13+
see LICENSE.txt and NOTICE.txt for more information.
14+

‎modules/raw-aes-keyring-browser/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# aws-encryption-sdk-javascript
2+
3+
The AWS Encryption SDK for JavaScript is a client-side encryption library designed to make it easy for everyone to encrypt and decrypt data using industry standards and best practices. It uses a data format compatible with the AWS Encryption SDKs in other languages. For more information on the AWS Encryption SDKs in all languages, see the [Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html).
4+
5+
## Installing
6+
7+
### In the browser
8+
9+
<instructions go here>
10+
11+
### In Node.JS
12+
13+
<instructions go here>
14+
15+
## Testing
16+
17+
### With npm
18+
19+
<instructions go here>
20+
21+
### Integration packages
22+
23+
<instructions go here>
24+
25+
## License
26+
27+
This SDK is distributed under the
28+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
29+
see LICENSE.txt and NOTICE.txt for more information.
30+

‎modules/raw-aes-keyring-node/README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# aws-encryption-sdk-javascript
2+
3+
The AWS Encryption SDK for JavaScript is a client-side encryption library designed to make it easy for everyone to encrypt and decrypt data using industry standards and best practices. It uses a data format compatible with the AWS Encryption SDKs in other languages. For more information on the AWS Encryption SDKs in all languages, see the [Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html).
4+
5+
## Installing
6+
7+
### In the browser
8+
9+
<instructions go here>
10+
11+
### In Node.JS
12+
13+
<instructions go here>
14+
15+
## Testing
16+
17+
### With npm
18+
19+
<instructions go here>
20+
21+
### Integration packages
22+
23+
<instructions go here>
24+
25+
## License
26+
27+
This SDK is distributed under the
28+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
29+
see LICENSE.txt and NOTICE.txt for more information.
30+

‎modules/raw-keyring/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# aws-encryption-sdk-javascript
2+
3+
The AWS Encryption SDK for JavaScript is a client-side encryption library designed to make it easy for everyone to encrypt and decrypt data using industry standards and best practices. It uses a data format compatible with the AWS Encryption SDKs in other languages. For more information on the AWS Encryption SDKs in all languages, see the [Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html).
4+
5+
## About <packagename>
6+
7+
This packages is not intended for direct use by clients. To get started with the AWS Encryption SDK for JavaScript, follow the instructions in [the README](https://github.com/awslabs/aws-encryption-sdk-javascript/blob/master/README.md).
8+
9+
## License
10+
11+
This SDK is distributed under the
12+
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
13+
see LICENSE.txt and NOTICE.txt for more information.
14+

0 commit comments

Comments
 (0)