Skip to content

Commit b4697d8

Browse files
chore: fix formatting and remove useless new lines and spaces from README (#25144)
> Fix formatting issues > Remove useless "new lines" and spaces
1 parent 0c1e885 commit b4697d8

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

README.md

+14-13
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ infrastructure definition and share it without worrying about boilerplate logic.
2222
The CDK is available in the following languages:
2323

2424
* JavaScript, TypeScript ([Node.js ≥ 14.15.0](https://nodejs.org/download/release/latest-v14.x/))
25-
- We recommend using a version in [Active LTS](https://nodejs.org/en/about/releases/)
25+
* We recommend using a version in [Active LTS](https://nodejs.org/en/about/releases/)
2626
* Python ([Python ≥ 3.6](https://www.python.org/downloads/))
2727
* Java ([Java ≥ 8](https://www.oracle.com/technetwork/java/javase/downloads/index.html) and [Maven ≥ 3.5.4](https://maven.apache.org/download.cgi))
2828
* .NET ([.NET ≥ 6.0](https://dotnet.microsoft.com/download))
@@ -73,23 +73,23 @@ in the CDK Developer Guide.
7373
[AWS CDK CLI]: https://docs.aws.amazon.com/cdk/latest/guide/tools.html
7474
[AWS Construct Library]: https://docs.aws.amazon.com/cdk/api/latest/docs/aws-construct-library.html
7575

76-
7776
## Getting Started
7877

7978
For a detailed walkthrough, see the [tutorial](https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html#hello_world_tutorial) in the AWS CDK [Developer Guide](https://docs.aws.amazon.com/cdk/latest/guide/home.html).
8079

8180
### At a glance
81+
8282
Install or update the [AWS CDK CLI] from npm (requires [Node.js ≥ 14.15.0](https://nodejs.org/download/release/latest-v14.x/)). We recommend using a version in [Active LTS](https://nodejs.org/en/about/releases/)
8383

84-
```console
84+
```sh
8585
npm i -g aws-cdk
8686
```
8787

8888
(See [Manual Installation](./MANUAL_INSTALLATION.md) for installing the CDK from a signed .zip file).
8989

9090
Initialize a project:
9191

92-
```console
92+
```sh
9393
mkdir hello-cdk
9494
cd hello-cdk
9595
cdk init sample-app --language=typescript
@@ -115,15 +115,15 @@ export class HelloCdkStack extends cdk.Stack {
115115

116116
Deploy this to your account:
117117

118-
```console
118+
```sh
119119
cdk deploy
120120
```
121121

122122
Use the `cdk` command-line toolkit to interact with your project:
123123

124-
* `cdk deploy`: deploys your app into an AWS account
125-
* `cdk synth`: synthesizes an AWS CloudFormation template for your app
126-
* `cdk diff`: compares your app with the deployed stack
124+
* `cdk deploy`: deploys your app into an AWS account
125+
* `cdk synth`: synthesizes an AWS CloudFormation template for your app
126+
* `cdk diff`: compares your app with the deployed stack
127127

128128
## Getting Help
129129

@@ -132,6 +132,7 @@ The best way to interact with our team is through GitHub. You can open an [issue
132132
If you have a support plan with AWS Support, you can also create a new [support case](https://console.aws.amazon.com/support/home#/).
133133

134134
You may also find help on these community resources:
135+
135136
* Look through the [API Reference](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-construct-library.html) or [Developer Guide](https://docs.aws.amazon.com/cdk/latest/guide)
136137
* The #aws-cdk Slack channel in [cdk.dev](https://cdk.dev)
137138
* Ask a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/aws-cdk)
@@ -148,12 +149,13 @@ We welcome community contributions and pull requests. See
148149
environment and submit code.
149150

150151
## Metrics collection
152+
151153
This solution collects anonymous operational metrics to help AWS improve the
152154
quality and features of the CDK. For more information, including how to disable
153-
this capability, please see the
154-
[developer guide](https://docs.aws.amazon.com/cdk/latest/guide/cli.html#version_reporting).
155+
this capability, please see the [developer guide](https://docs.aws.amazon.com/cdk/latest/guide/cli.html#version_reporting).
155156

156157
## More Resources
158+
157159
* [CDK Workshop](https://cdkworkshop.com/)
158160
* [Construct Hub](https://constructs.dev) - Find and use open-source Cloud Development Kit (CDK) libraries
159161
* Best Practices
@@ -165,14 +167,13 @@ this capability, please see the
165167
* **[CDK Construction Zone](https://www.twitch.tv/collections/9kCOGphNZBYVdA)** - A Twitch live coding series hosted by the CDK team, season one episodes:
166168
* Triggers: Join us as we implement [Triggers](https://github.com/aws/aws-cdk-rfcs/issues/71), a Construct for configuring deploy time actions. Episodes 1-3:
167169
* [S1E1](https://www.twitch.tv/videos/917691798): Triggers (part 1); **Participants:** @NetaNir, @eladb, @richardhboyd
168-
* [S1E2](https://www.twitch.tv/videos/925801382): Triggers (part 2); **Participants:** @NetaNir, @eladb, @iliapolo
170+
* [S1E2](https://www.twitch.tv/videos/925801382): Triggers (part 2); **Participants:** @NetaNir, @eladb, @iliapolo
169171
* [S1E3](https://www.twitch.tv/videos/944565768): Triggers (part 3); **Participants:** @NetaNir, @eladb, @iliapolo, @RomainMuller
170172
* [S1E4](https://www.twitch.tv/aws/video/960287598): [Tokens](https://docs.aws.amazon.com/cdk/latest/guide/tokens.html) Deep Dive; **Participants:** @NetaNir,@rix0rrr, @iliapolo, @RomainMuller
171173
* [S1E5](https://www.twitch.tv/videos/981481112): [Assets](https://docs.aws.amazon.com/cdk/latest/guide/assets.html) Deep Dive; **Participants:** @NetaNir, @eladb, @jogold
172174
* [S1E6](https://www.twitch.tv/aws/video/1005334364): [Best Practices](https://aws.amazon.com/blogs/devops/best-practices-for-developing-cloud-applications-with-aws-cdk/); **Participants:** @skinny85, @eladb, @rix0rrr, @alexpulver
173-
* [S1E7](https://www.twitch.tv/videos/1019059654): Tips and Tricks From The CDK Team; **Participants:** All the CDK team!
175+
* [S1E7](https://www.twitch.tv/videos/1019059654): Tips and Tricks From The CDK Team; **Participants:** All the CDK team!
174176
* [Examples](https://github.com/aws-samples/aws-cdk-examples)
175177
* [Changelog](./CHANGELOG.md)
176178
* [NOTICE](./NOTICE)
177179
* [License](./LICENSE)
178-

0 commit comments

Comments
 (0)