Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hez2010 committed Mar 12, 2021
1 parent 7b62058 commit 503a12c
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,12 @@ Build status: ![.NET](https://github.com/hez2010/TypedocConverter/workflows/.NET
- [x] Properties
- [x] Methods
- [x] Events
- [x] Indexer
- [ ] Types
- [x] String literals
- [x] Type literals
- [ ] Type alias
- [ ] Union types
- [x] Type alias*
- [x] Union types*
- [ ] Intersection types
- [x] Split entities to different files
- [x] Auto rename conflict parameter names
Expand All @@ -35,6 +36,8 @@ Build status: ![.NET](https://github.com/hez2010/TypedocConverter/workflows/.NET
- [x] Nullable Reference Types
- [ ] ...

`*: Partial support`

## Quick start
TypeScript code `input.ts`:
```typescript
Expand Down Expand Up @@ -134,7 +137,7 @@ declare namespace test {
}
```

With below commands:
With below commands (need a `tsconfig.json`):
```bash
typedoc input.ts --json output.json
TypedocConverter --inputfile output.json --outputfile output.cs
Expand Down Expand Up @@ -375,4 +378,4 @@ Arguments:
We have prepared some prebuilt binaries for Windows, Linux and macOS.
You can download them directly from [Releases](https://github.com/hez2010/TypedocConverter/releases)

Prerequisites: [.NET Runtime 5.0](https://dotnet.microsoft.com/download/dotnet-core/5.0)
Prerequisites for non-native binaries: [.NET Runtime 5.0](https://dotnet.microsoft.com/download/dotnet-core/5.0)

0 comments on commit 503a12c

Please sign in to comment.