Skip to content

Commit 9e6a0bc

Browse files
committed
docs: Update README
1 parent 1f6011b commit 9e6a0bc

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

.copier-answers.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ insiders_email: [email protected]
1313
insiders_repository_name: griffe-typedoc
1414
project_description: Signatures for entire TypeScript programs using TypeDoc.
1515
project_name: Griffe TypeDoc
16-
public_release: false
16+
public_release: true
1717
python_package_command_line_name: griffe-typedoc
1818
python_package_distribution_name: griffe-typedoc
1919
python_package_import_name: griffe_typedoc

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Griffe TypeDoc
22

3+
[![ci](https://github.com/mkdocstrings/griffe-typedoc/workflows/ci/badge.svg)](https://github.com/mkdocstrings/griffe-typedoc/actions?query=workflow%3Aci)
34
[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/griffe-typedoc/)
5+
[![pypi version](https://img.shields.io/pypi/v/griffe-typedoc.svg)](https://pypi.org/project/griffe-typedoc/)
46
[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#griffe-typedoc:gitter.im)
57

68
Signatures for entire TypeScript programs using [TypeDoc](https://typedoc.org/).
@@ -10,7 +12,9 @@ Feedback is welcome.
1012

1113
## Installation
1214

13-
This project is available to sponsors only, through my Insiders program. See Insiders [explanation](https://mkdocstrings.github.io/griffe-typedoc/insiders/) and [installation instructions](https://mkdocstrings.github.io/griffe-typedoc/insiders/installation/).
15+
```bash
16+
pip install griffe-typedoc
17+
```
1418

1519
## Usage
1620

@@ -76,4 +80,3 @@ data = load(
7680
```
7781

7882
See our [API reference](https://mkdocstrings.github.io/griffe-typedoc/reference/griffe_typedoc/).
79-

0 commit comments

Comments
 (0)