Skip to content

Commit fa2827e

Browse files
docs: clean up injected README (#44)
- Only show `npm` installation example - Format usage example as TypeScript with prettier - Link to license file
1 parent ebaeb13 commit fa2827e

File tree

1 file changed

+15
-20
lines changed

1 file changed

+15
-20
lines changed

test/fixtures/inject/valid/README.md

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,28 @@
22

33
## Installation
44

5-
```
6-
npm install --save sanity-plugin-test-plugin
5+
```sh
6+
npm install sanity-plugin-test-plugin
77
```
88

9-
or
9+
## Usage
1010

11-
```
12-
yarn add sanity-plugin-test-plugin
13-
```
11+
Install the plugin in your [Sanity Studio](https://sanity.io/studio) configuration
12+
`sanity.config.ts` (or `.js`):
1413

15-
## Usage
14+
```ts
15+
import {defineConfig} from 'sanity'
16+
import {myPlugin} from 'sanity-plugin-test-plugin'
1617

17-
Add it as a plugin in sanity.config.ts (or .js):
18+
export const defineConfig({
19+
// ...
1820

19-
```
20-
import {defineConfig} from 'sanity'
21-
import {myPlugin} from 'sanity-plugin-test-plugin'
22-
23-
export const defineConfig({
24-
/...
25-
plugins: [
26-
myPlugin({})
27-
]
28-
})
21+
plugins: [
22+
myPlugin(),
23+
],
24+
})
2925
```
3026

3127
## License
3228

33-
MIT © Test Person
34-
See LICENSE
29+
[MIT](LICENSE) © Test Person

0 commit comments

Comments
 (0)