Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nenoNaninu committed Nov 19, 2022
1 parent 02982df commit f4d02b6
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,16 +103,23 @@ The example of the actual generated code exists in [`/samples/console.typescript
Use `TypedSignalR.Client.TypeScript.Generatorr`(CLI Tool) to generate TypeScript source code to provide strongly typed SignalR clients.
`TypedSignalR.Client.TypeScript.Generatorr` can be easily installed using .NET Global Tools. You can use the installed tools with the command `dotnet tsts`(**T**yped**S**ignal**R**.Client.**T**ype**S**cript).

```
```bash
# install (.NET 7)
dotnet tool install --global TypedSignalR.Client.TypeScript.Generator
dotnet tsrts help

# update
dotnet tool update --global TypedSignalR.Client.TypeScript.Generator

# install (.NET 6)
dotnet tool install --global TypedSignalR.Client.TypeScript.Generator --version 1.2.2
```

## Usage

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

```
```bash
dotnet add package TypedSignalR.Client.TypeScript.Attributes
dotnet add package TypedSignalR.Client.TypeScript.Analyzer (optional, but recommended.)
dotnet add package Tapper.Analyzer (optional, but recommended.)
Expand Down Expand Up @@ -158,7 +165,7 @@ public record Message(string Username, string Content, DateTime TimeStamp);
Finally, enter the following command.
This command analyzes C# and generates TypeScript code.

```
```bash
dotnet tsrts --project path/to/Project.csproj --output generated
```

Expand Down

0 comments on commit f4d02b6

Please sign in to comment.