Skip to content

Commit 3fa72b0

Browse files
authored
Update README, hide addons:auth for now. (#17)
1 parent bf3df82 commit 3fa72b0

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,16 @@
66
[![Join Slack](https://img.shields.io/badge/join-slack-9B69A0.svg)](https://nimbella-community.slack.com/)
77
[![Twitter](https://img.shields.io/twitter/follow/nimbella.svg?style=social&logo=twitter)](https://twitter.com/intent/follow?screen_name=nimbella)
88

9-
A Netlify Build Plugin that extends Netlify Sites with support for portable and stateful serverless functions using [Nimbella](https://nimbella.com/product/platform). The add-on enables Netlify developers to deploy serverless functions and stateful APIs to the Nimbella cloud 1) with more programming language choices, 2) easier packaging, 3) customizable runtimes and durations, and 4) cloud portability.
9+
The Nimbella add-on for Netlify is a Netlify Build Plugin that extends Netlify Sites with portable and stateful serverless functions using [Nimbella](https://nimbella.com/product/platform). The add-on enables developers to deploy sites to Netlify's CDN, and serverless functions and stateful APIs to the [Nimbella Cloud](https://nimbella.com).
1010

11-
Learn more about Nimbella's integration for Netlify from [here](https://nimbella.com/integrations/netlify).
11+
The Nimbella add-on provides the following benefits.
12+
1. **More runtimes:** implement functions in numerous languages including Python, Rust, Swift, Ruby, PHP, Java, Go, Node, and Deno.
13+
2. **Resource customization:** run functions for longer durations, and with more memory.
14+
3. **Support for key-value and object stores:** build stateful APIs, and handle images or files.
15+
4. **Easier packaging:** skip the hassles of web packing and working with dependencies.
16+
5. **Cloud portability**: repeatable deployments that work across clouds.
17+
18+
Learn more about the Nimbella add-on for Netlify [on our website](https://nimbella.com/integrations/netlify).
1219

1320
- [Add-On Setup](#add-on-setup)
1421
- [New to Nimbella](#new-to-nimbella)
@@ -33,9 +40,10 @@ To do that, run the following command from the base of your local project direct
3340
netlify addons:create nimbella
3441
```
3542

36-
The addon will create a Nimbella namespace where your resources are allocated. Your Nimbella namespace includes your serverless functions, a dedicated key-value store, and access to an integrated object store.
43+
The add-on will create a Nimbella namespace where your resources are allocated. Your Nimbella namespace includes your serverless functions, a dedicated key-value store, and access to an integrated object store.
3744

38-
You may claim the namespace and login to your Nimbella account by running `netlify addons:auth nimbella`.
45+
<!--TODO: add steps to claim the namespace and configure `nim` CLI when the flow is enabled. -->
46+
<!--You may claim the namespace and login to your Nimbella account by running `netlify addons:auth nimbella`.-->
3947

4048
### Existing Nimbella Developer
4149

@@ -72,7 +80,7 @@ path = "/api/" # The prefix path to access your deployed packages.
7280

7381
In this section, you will learn how to structure your repository and `netlify.toml` for this plugin to deploy your functions on Nimbella Cloud.
7482

75-
**Note:** Deployment of packages/functions to Nimbella is skipped when the build context is not production. We're working on an enhancement that will allow you to deploy preview builds to staging namespace on Nimbella.
83+
**Note:** Deployment of packages/functions to Nimbella is skipped when the build context is not "production". We're working on an enhancement that will allow you to deploy preview builds to staging namespaces on Nimbella.
7684

7785
#### Use Nimbella Projects with Netlify Sites
7886

@@ -115,9 +123,10 @@ Move the `functions` property under `build` to `nimbella` inside `netlify.toml`.
115123

116124
This plugin builds your functions using a modified version of [netlify-lambda](https://github.com/netlify/netlify-lambda). You can get rid of any build steps you're performing on functions since the plugin handles it for you.
117125

118-
All enviroment variables present in the build runtime during Netlify build (except `CI` and `NETLIFY`) are made availabe to the deployed functions on Nimbella Cloud.
119-
120-
**Note:** When you're using `packages` along with functions, make sure to apend "default" to `/api/` to invoke the functions as all functions are deployed under `default` package of your namespace.
126+
**Notes:**
127+
- None of environment variables present in the Netlify build runtime are made available to the deployed functions on Nimbella Cloud. _An enhancement to permit selective forwarding of environment variables is coming soon._
128+
- Replace occurrences of `/.netlify/functions` in your API calls with `/.netlify/nimbella`, or use `/api`, as your API path instead.
129+
- All Netlify functions are deployed to a "default" package in your Nimbella namespace. The package name is required in the API path. For Netlify functions, the path will be `/.netlify/nimbella/default/` or `/api/default`. For named packages, replace `default` with your package name instead.
121130

122131
## Examples
123132

0 commit comments

Comments
 (0)