Skip to content

Commit d8e75f6

Browse files
authored
README - fix up markdown (#158)
When I looked at the readme, I noticed that some of the code blocks were not rendering properly since they had different levels on indentation with the ordered list items they were under. This pull request makes minor formatting improvements to the `README.md` file to enhance readability and consistency. The changes include the addition of blank lines for better spacing and the removal of unnecessary blank lines in code blocks and instructions. Formatting improvements: * Added blank lines between sections in the Table of Contents for better readability. (`README.md`: [README.mdL16-R24](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L16-R24)) * Inserted blank lines before and after lists in the "Getting Started" and "Adding a Feature Slice" sections to improve spacing and clarity. (`README.md`: [[1]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R94-L113) [[2]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R129-L175) * Removed unnecessary blank lines within code blocks and instructions to maintain a cleaner structure. (`README.md`: [README.mdR129-L175](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R129-L175))
1 parent 1a438a2 commit d8e75f6

File tree

1 file changed

+48
-55
lines changed

1 file changed

+48
-55
lines changed

README.md

Lines changed: 48 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,15 @@
1313

1414
[comment]: <> (Table of contents generated with markdown-toc http://ecotrust-canada.github.io/markdown-toc/)
1515
<!-- TOC -->
16-
- [SSW Vertical Slice Architecture Template](#ssw-vertical-slice-architecture-template)
17-
* [🤔 What is it?](#---what-is-it-)
18-
* [✨ Features](#--features)
19-
* [🎉 Getting Started](#---getting-started)
20-
* [🎓 Learn More](#---learn-more)
21-
* [🚀 Publishing Template](#---publishing-template)
22-
* [🤝 Contributing](#---contributing)
16+
[SSW Vertical Slice Architecture Template](#ssw-vertical-slice-architecture-template)
17+
18+
* [🤔 What is it?](#---what-is-it-)
19+
* [✨ Features](#--features)
20+
* [🎉 Getting Started](#---getting-started)
21+
* [🎓 Learn More](#---learn-more)
22+
* [🚀 Publishing Template](#---publishing-template)
23+
* [🤝 Contributing](#---contributing)
24+
2325
<!-- TOC -->
2426

2527
## 🤔 What is it?
@@ -89,93 +91,84 @@ Read more on [SSW Rules to Better Vertical Slice Architecture](https://www.ssw.c
8991
## 🎉 Getting Started
9092

9193
### Prerequisites
94+
9295
- [Docker](https://www.docker.com/get-started/) / [Podman](https://podman.io/get-started)
9396
- [Dotnet 9](https://dotnet.microsoft.com/en-us/download/dotnet/9.0)
9497

9598
### Installing the Template
9699

97-
1. Install the SSW CA template
98-
99-
```bash
100-
dotnet new install SSW.VerticalSliceArchitecture.Template
101-
```
100+
1. Install the SSW VSA template
101+
```bash
102+
dotnet new install SSW.VerticalSliceArchitecture.Template
103+
```
102104

103105
> NOTE: The template only needs to be installed once. Running this command again will update your version of the template.
104106
105107
2. Create a new directory
106-
107-
```bash
108-
mkdir Sprout
109-
cd Sprout
110-
```
108+
```bash
109+
mkdir Sprout
110+
cd Sprout
111+
```
111112

112113
3. Create a new solution
113-
114-
```bash
115-
dotnet new ssw-vsa
116-
```
114+
```bash
115+
dotnet new ssw-vsa
116+
```
117117

118118
> NOTE: `name` is optional; if you don't specify it, the directory name will be used as the solution name and project namespaces.
119119
120120
Alternatively, you can specify the `name` and `output` directory as follows:
121121

122-
```bash
123-
dotnet new ssw-vsa --name {{SolutionName}} --output .\
124-
```
122+
```bash
123+
dotnet new ssw-vsa --name {{SolutionName}}
124+
```
125125

126126
### Adding a Feature Slice
127127

128128
To speed up development there is a `dotnet new` template to create a full Vertical Slice:
129+
129130
- Creates a domain object in `Common/Domain/*`
130131
- Adds domain configuration in `Common/Persistence/*`
131132
- Creates Command & Query API endpoints in `Features/*`
132133

133134
1. Add a new Feature
134-
135-
```bash
136-
cd src/WebApi/
137-
138-
dotnet new ssw-vsa-slice --feature Person --feature-plural People
139-
```
135+
```bash
136+
cd src/WebApi/
137+
dotnet new ssw-vsa-slice --feature Person --feature-plural People
138+
```
140139

141140
`--feature` or `-f` where the value is the **singular** name of the feature.
142141
`--feature-plural` or `-fp` where the value is the **plural** name of the feature.
143142

144143
2. Configure this Feature
145-
146-
This project uses [strongly typed IDs](https://www.ssw.com.au/rules/do-you-use-strongly-typed-ids/), which require registration in the `VogenEfCoreConverters` class:
147-
148-
```csharp
149-
// Register the newly created Entity ID here
150-
[EfCoreConverter<PersonId>]
151-
internal sealed partial class VogenEfCoreConverters;
152-
```
144+
This project uses [strongly typed IDs](https://www.ssw.com.au/rules/do-you-use-strongly-typed-ids/), which require registration in the `VogenEfCoreConverters` class:
145+
```csharp
146+
// Register the newly created Entity ID here
147+
[EfCoreConverter<PersonId>]
148+
internal sealed partial class VogenEfCoreConverters;
149+
```
153150

154151
3. Add a migration for the new Entity
155-
156-
```bash
157-
dotnet ef migrations add --project src/WebApi/WebApi.csproj --startup-project src/WebApi/WebApi.csproj --output-dir Common/Database/Migrations PersonTable
158-
```
152+
```bash
153+
dotnet ef migrations add --project src/WebApi/WebApi.csproj --startup-project src/WebApi/WebApi.csproj --output-dir Common/Database/Migrations PersonTable
154+
```
159155

160156
### Running the Solution
161157

162158
1. Change directory
163-
164159
Windows:
165-
```ps
166-
cd tools\AppHost\
167-
```
168-
160+
```ps
161+
cd tools\AppHost\
162+
```
169163
Mac/Linux:
170-
```bash
171-
cd tools/AppHost/
172-
```
164+
```bash
165+
cd tools/AppHost/
166+
```
173167

174168
2. Run the solution
175-
176-
```bash
177-
dotnet run
178-
```
169+
```bash
170+
dotnet run
171+
```
179172

180173
> **NOTE:** The first time you run the solution, it may take a while to download the docker images, create the DB, and seed the data.
181174
@@ -219,4 +212,4 @@ Template will be published to NuGet.org when changes are made to `VerticalSliceA
219212
220213
## 🤝 Contributing
221214

222-
Contributions, issues and feature requests are welcome! See [Contributing](./CONTRIBUTING.md) for more information.
215+
Contributions, issues and feature requests are welcome! See [Contributing](./CONTRIBUTING.md) for more information.

0 commit comments

Comments
 (0)