From 904f94ea617e86a5a8214d38c34f164066d79a6d Mon Sep 17 00:00:00 2001 From: Victoria Date: Thu, 9 May 2019 14:54:06 -0500 Subject: [PATCH] Move all docs on using the plugin to serverless, make Readme just on how to develop on the plugin --- README.md | 70 +++++++------------------------------------------------ 1 file changed, 9 insertions(+), 61 deletions(-) diff --git a/README.md b/README.md index 7b8176d..0bad83b 100644 --- a/README.md +++ b/README.md @@ -4,68 +4,11 @@ Serverless plugin for [Cloudflare Workers](https://developers.cloudflare.com/wor ## Documentation -https://serverless.com/framework/docs/providers/cloudflare/guide/quick-start/ +See full documentation for using the plugin at: [Serverless for Cloudflare](https://serverless.com/framework/docs/providers/cloudflare/guide/quick-start/) -### Bundling with Webpack -You can have the plugin automatically bundle your code into one file using [webpack](https://webpack.js.org/). This is a great solution if you are fine with a no frills bundling. - -You can use a single global webpack config to bundle your assets. And this webpack config will be built during the packaging time, before individual functions are prepared. To use this, add `webpackConfig` to your service section in serverless config, with value as the path to the webpack config. - -```yaml -service: - name: service-name - webpackConfig: webpack.config #webpack config path without js extension from root folder. - config: - accountId: ${env:CLOUDFLARE_ACCOUNT_ID} - zoneId: ${env:CLOUDFLARE_ZONE_ID} - -``` - -You can also add a function level webpack configuration in addition to a global webpack configuration. This helps you to process bundling different for an individual function than the global webpack config explained earlier. To use this, set the webpack config path to the function level `webpack` variable. Setting function level `webpack` variable to `true` will force webpack to bundle the function script with a default web pack configuration. Setting `webpack` key to `false` will turn off webpack for the function. (i.e the function script will not be fetched from dist folder) - -Simply add `webpack: true | ` to your config block. - -```yaml -functions: - myfunction: - name: myfunction - webpack: true #or the web pack config path for this function - script: handlers/myfunctionhandler - events: - - http: - url: example.com/myfunction - method: GET - -``` - -### Environment Variables - -While Cloudflare Workers doesn't exactly offer environment vairables, we can bind global variables to values, essentially giving the same capabilities. In your function configuration, add key value pairs in `environment` - -```yaml -functions: - myFunction: - environment: - MYKEY: value_of_my_key - ANOTHER_KEY_OF_MINE: sweet_child_o_mine - -``` - -Then in your script, you can reference `MYKEY` to access the value. - -You can also add an environment block under `provider`. These will get added to every function. If a function defines the same variable, the function defintion will overwrite the provider block definition. - -```yaml -provider: - name: cloudflare - environment: - MYKEY: value_of_my_key - ANOTHER_KEY_OF_MINE: sweet_child_o_mine - -``` - -### Using Cloudflare KV Storage + + +## Develop on Plugin + +Add documentation on how to develop on the plugin here please :) +Issue tracked at https://github.com/cloudflare/serverless-cloudflare-workers/issues/37 \ No newline at end of file