Skip to content
This repository was archived by the owner on Sep 12, 2019. It is now read-only.

Commit 73f67a6

Browse files
authored
Update README.md
1 parent 0b8c369 commit 73f67a6

File tree

1 file changed

+18
-39
lines changed

1 file changed

+18
-39
lines changed

README.md

Lines changed: 18 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,29 @@
11
netlify-dev-plugin
22
==================
33

4-
Netlify development tools plugin
5-
6-
[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
7-
[![Version](https://img.shields.io/npm/v/netlify-dev-plugin.svg)](https://npmjs.org/package/netlify-dev-plugin)
8-
[![Downloads/week](https://img.shields.io/npm/dw/netlify-dev-plugin.svg)](https://npmjs.org/package/netlify-dev-plugin)
9-
[![License](https://img.shields.io/npm/l/netlify-dev-plugin.svg)](https://github.com/netlify/netlify-dev-plugin/blob/master/package.json)
10-
11-
<!-- toc -->
12-
* [Usage](#usage)
13-
* [Commands](#commands)
14-
<!-- tocstop -->
15-
# Usage
16-
<!-- usage -->
17-
```sh-session
18-
$ npm install -g netlify-dev-plugin
19-
$ oclif-example COMMAND
20-
running command...
21-
$ oclif-example (-v|--version|version)
22-
netlify-dev-plugin/0.1.0 linux-x64 node-v10.15.0
23-
$ oclif-example --help [COMMAND]
24-
USAGE
25-
$ oclif-example COMMAND
26-
...
27-
```
28-
<!-- usagestop -->
29-
# Commands
30-
<!-- commands -->
31-
* [`oclif-example hello`](#oclif-example-hello)
4+
Netlify CLI plugin for local dev experience.
5+
6+
## Usage
7+
8+
* `netlify dev` start a local dev server for the build tool you're using
9+
* `netlify dev:exec <command>` runs a shell command within the netlify dev environment
3210

33-
## `oclif-example hello`
11+
## Using the beta
3412

35-
Describe the command here
13+
Currently the Netlify dev plugin is in private beta. You'll need to follow these steps to enable it:
3614

15+
Make sure Netlify CLI is installed and up to date:
16+
17+
```
18+
npm install -g netlify-cli
3719
```
38-
USAGE
39-
$ oclif-example hello
4020

41-
OPTIONS
42-
-n, --name=name name to print
21+
Then clone and activate the plugin:
4322

44-
DESCRIPTION
45-
...
46-
Extra documentation goes here
23+
```
24+
git clone [email protected]:netlify/netlify-dev-plugin.git
25+
cd netlify-dev-plugin
26+
netlify plugins:link .
4727
```
4828

49-
_See code: [src/commands/hello.js](https://github.com/netlify/netlify-dev-plugin/blob/v0.1.0/src/commands/hello.js)_
50-
<!-- commandsstop -->
29+
Now you're both ready to start testing netlify dev and to contribute to the project.

0 commit comments

Comments
 (0)