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

Commit f8319bb

Browse files
authored
Merge pull request #43 from netlify/updated-readme
Add some context to the README
2 parents 7dc08c4 + d3b8730 commit f8319bb

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
Netlify CLI plugin for local dev experience.
44

5+
## What is Netlify Dev?
6+
7+
Netlify Dev brings the power of Netlify's Edge Logic layer, serverless functions and [add-on ecosystem](#using-add-ons) to your local laptop. It runs Netlify's production routing engine in a local dev server to make all redirects, proxy rules, function routes or add-on routes available locally and injects the correct environment variables from your site environment, installed add-ons or your netlify.toml file into your build and function environment.
8+
9+
It automatically detects common tools like Gatsby, Hugo, React Static, Eleventy, and more, to give a zero config setup for your local dev server and can help scaffolding new functions as you work on them.
10+
511
## Usage
612

713
- `netlify dev` start a local dev server for the build tool you're using
@@ -146,3 +152,22 @@ Each serverless function will be exposed on a URL corresponding to its path and
146152
`./functions/hello-world.js` -> `http://localhost:{PORT}/.netlify/functions/hello-world`
147153
148154
`./functions/my-api/hello-world.js` -> `http://localhost:{PORT}/.netlify/functions/my-api/hello-world`
155+
156+
157+
### Using Add-ons
158+
159+
Add-ons are a way for Netlify users to extend the functionality of their Jamstack site/app.
160+
161+
[Add-on docs](https://www.netlify.com/docs/partner-add-ons/).
162+
163+
To try out an add-on with Netlify dev, run the `netlify addons:create` command:
164+
165+
```
166+
netlify addons:create fauna
167+
```
168+
169+
The above command will install the FaunaDB add-on and provision a noSQL database for your site to leverage. The FaunaDB add-on injects environment variables into your site's build process and the serverless functions.
170+
171+
Or install this [one click example](https://github.com/netlify/fauna-one-click).
172+
173+
After you have installed an add-on, it will be visible with the `netlify addons:list` command inside your site's current working directory.

0 commit comments

Comments
 (0)