Skip to content

Commit

Permalink
docs: clean up injected README (#44)
Browse files Browse the repository at this point in the history
- Only show `npm` installation example
- Format usage example as TypeScript with prettier
- Link to license file
  • Loading branch information
mariuslundgard committed Nov 10, 2022
1 parent ebaeb13 commit fa2827e
Showing 1 changed file with 15 additions and 20 deletions.
35 changes: 15 additions & 20 deletions test/fixtures/inject/valid/README.md
Expand Up @@ -2,33 +2,28 @@

## Installation

```
npm install --save sanity-plugin-test-plugin
```sh
npm install sanity-plugin-test-plugin
```

or
## Usage

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

## Usage
```ts
import {defineConfig} from 'sanity'
import {myPlugin} from 'sanity-plugin-test-plugin'

Add it as a plugin in sanity.config.ts (or .js):
export const defineConfig({
// ...

```
import {defineConfig} from 'sanity'
import {myPlugin} from 'sanity-plugin-test-plugin'
export const defineConfig({
/...
plugins: [
myPlugin({})
]
})
plugins: [
myPlugin(),
],
})
```

## License

MIT © Test Person
See LICENSE
[MIT](LICENSE) © Test Person

0 comments on commit fa2827e

Please sign in to comment.