Skip to content

Commit 4085890

Browse files
authored
Merge pull request #263 from nenoNaninu/update_readme20241201
update README.md
2 parents 597ec12 + 95bb0b2 commit 4085890

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ You only need to execute one command to analyze your C# code and generate TypeSc
5151
Please see the [Install Using .NET Tool](#install-using-net-tool) and [Usage](#usage) sections for more information.
5252

5353
```bash
54-
dotnet tsrts --project path/to/Project.csproj --output generated
54+
$ dotnet tsrts --project path/to/Project.csproj --output generated
5555
```
5656

5757
```ts
@@ -122,21 +122,21 @@ Use `TypedSignalR.Client.TypeScript.Generatorr`(CLI Tool) to generate TypeScript
122122
```bash
123123
# install
124124
# TypedSignalR.Client.TypeScript CLI (dotnet tool) requires .NET 7, but your app TFM can use .NET 6, etc.
125-
dotnet tool install --global TypedSignalR.Client.TypeScript.Generator
126-
dotnet tsrts help
125+
$ dotnet tool install --global TypedSignalR.Client.TypeScript.Generator
126+
$ dotnet tsrts help
127127

128128
# update
129-
dotnet tool update --global TypedSignalR.Client.TypeScript.Generator
129+
$ dotnet tool update --global TypedSignalR.Client.TypeScript.Generator
130130
```
131131

132132
## Usage
133133

134134
First, add the following packages to your project. TypedSignalR.Client.TypeScript.Analyzer is optional, but recommended.
135135

136136
```bash
137-
dotnet add package TypedSignalR.Client.TypeScript.Attributes
138-
dotnet add package TypedSignalR.Client.TypeScript.Analyzer (optional, but recommended.)
139-
dotnet add package Tapper.Analyzer (optional, but recommended.)
137+
$ dotnet add package TypedSignalR.Client.TypeScript.Attributes
138+
$ dotnet add package TypedSignalR.Client.TypeScript.Analyzer (optional, but recommended.)
139+
$ dotnet add package Tapper.Analyzer (optional, but recommended.)
140140
```
141141

142142
By adding `TypedSignalR.Client.TypeScript.Attributes` package, you can use three attributes.
@@ -180,7 +180,7 @@ Finally, enter the following command.
180180
This command analyzes C# and generates TypeScript code.
181181

182182
```bash
183-
dotnet tsrts --project path/to/Project.csproj --output generated
183+
$ dotnet tsrts --project path/to/Project.csproj --output generated
184184
```
185185

186186
The generated code can be used as follows.
@@ -394,7 +394,7 @@ builder.Services.AddSignalR()
394394
If you do not set any options in `AddMessagePackProtocol`, use the following command.
395395

396396
```bash
397-
dotnet tsrts --project path/to/Project.csproj --output generated --serializer MessagePack --naming-style none --enum name
397+
$ dotnet tsrts --project path/to/Project.csproj --output generated --serializer MessagePack --naming-style none --enum name
398398
```
399399

400400
### Recommended Configuration
@@ -418,7 +418,7 @@ builder.Services.AddSignalR()
418418
If you set up the above configuration, use the following command
419419

420420
```bash
421-
dotnet tsrts --project path/to/Project.csproj --output generated --serializer MessagePack --naming-style none
421+
$ dotnet tsrts --project path/to/Project.csproj --output generated --serializer MessagePack --naming-style none
422422
```
423423

424424
## Related Work

0 commit comments

Comments
 (0)