Skip to content

Commit 5b077b8

Browse files
committed
format readme
Signed-off-by: shmck <[email protected]>
1 parent baaf968 commit 5b077b8

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

Diff for: README.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,24 @@ Works with a variety of languages: JavaScript, Python, Bash, SQL, with more to c
1919

2020
![CodeRoad Example](./docs/static/gif/coderoad-example.gif)
2121

22+
---
23+
2224
## [📖 Documentation](https://coderoad.github.io/docs/overview)
2325

2426
- [Create a Tutorial](https://coderoad.github.io/docs/build-tutorial)
2527
- [Develop the Extension](https://coderoad.github.io/docs/development)
2628

27-
### How CodeRoad Works
29+
## How CodeRoad Works
2830

2931
1. Text is written in Markdown. [🔗](https://github.com/coderoad/fcc-learn-npm/blob/master/TUTORIAL.md)
30-
2. Tutorials are stored and played in Git. [🔗](https://github.com/coderoad/fcc-learn-npm/commits/v0.4.2)
31-
3. Hooks & actions give access to the command line & VSCode API. [📖](https://coderoad.github.io/docs/hooks-actions/)
32+
2. Tutorials are built on Git using a TDD pattern. [🔗](https://github.com/coderoad/fcc-learn-npm/commits/v0.4.2)
33+
3. Hooks & actions give flexible access to the command line & VSCode API. [📖](https://coderoad.github.io/docs/hooks-actions/)
34+
35+
▶️ &nbsp;[See a video explaining how CodeRoad works](http://www.youtube.com/watch?v=htrbKlgAvuE 'How CodeRoad Works')
3236

33-
- ▶️ [See a video explaining how CodeRoad works](http://www.youtube.com/watch?v=htrbKlgAvuE 'How CodeRoad Works')
34-
- 📖 [Learn more](https://coderoad.github.io/docs/how-coderoad-works)
37+
📖 &nbsp;[Learn more](https://coderoad.github.io/docs/how-coderoad-works)
38+
39+
---
3540

3641
## Getting Started
3742

@@ -58,6 +63,8 @@ To start the extension, inside VSCode:
5863
- select “View” > “Command Palette” from the top panel OR press `cmd/ctrl + shift + P`
5964
- in the command palette popup, search for and run `CodeRoad:Start`
6065

66+
---
67+
6168
## Contributing
6269

6370
CodeRoad is an ambitious project, we're always looking for contributors :)

0 commit comments

Comments
 (0)