Skip to content

Commit 0a3f182

Browse files
authored
Merge pull request digitalocean#1 from beardicus/docs/add-readme
create readme
2 parents 98d012e + 38442db commit 0a3f182

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Sample Function: Go "Hello World"
2+
3+
## Introduction
4+
5+
This repository contains a sample "Hello World" function written in Go. You can deploy it on DigitalOcean's App Platform as a Serverless Function component.
6+
7+
**Note: This feature is currently in a [limited beta release](https://docs.digitalocean.com/products/platform/product-lifecycle/#beta). Following these steps may result in charges for the use of DigitalOcean services.**
8+
9+
### Requirements
10+
11+
* You need a DigitalOcean account. If you don't already have one, you can sign up at [https://cloud.digitalocean.com/registrations/new](https://cloud.digitalocean.com/registrations/new).
12+
* You need to have access to the beta release of App Platform Serverless Functions. You can sign up for notifications about beta and early access releases [using this form](https://www.digitalocean.com/nimbella).
13+
14+
## Deploying the Function
15+
16+
During the beta, documentation for Serverless Functions will be available to beta participants only in the [Serverless Functions Closed Beta Google Doc](https://docs.google.com/document/d/1qhxnl4ndb0Jh2WkNnNLa2lAUo6u7EAfLyBlUsaPZA0Y). Please refer to this document for instructions on how to deploy Serverless Functions in App Platform.
17+
18+
## Using the Function
19+
20+
Accessing the function with the `?name=` query parameter will greet the specified name. For example, `?name=Alice` will return `Hello Alice`. Using no query parameters will return `Hello stranger`.
21+
22+
### Learn More
23+
24+
You can learn more about App Platform and how to manage and update your application in [the official App Platform Documentation](https://www.digitalocean.com/docs/app-platform/).
25+
26+
27+
28+
29+
30+
31+

0 commit comments

Comments
 (0)