Skip to content

Commit 714a29c

Browse files
authored
Updating the README (#137)
* Updating the branding * Description of the product * Link to samples, docs, license, and contributor guideline * Add beta warning
1 parent 70276bd commit 714a29c

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
# firebase-functions
1+
# Firebase SDK for Cloud Functions
22

3-
The `firebase-functions` package provides an SDK for defining Firebase Functions.
3+
The `firebase-functions` package provides an SDK for defining Cloud Functions for Firebase.
44

5-
## Installation
5+
Cloud Functions is a hosted, private, and scalable Node.js environment where you can run JavaScript code. The Firebase SDK for Cloud Functions integrates the Firebase platform by letting you write code that responds to events and invokes functionality exposed by other Firebase features.
66

7-
In your Firebase project's `functions` directory, run:
7+
_This is a Beta release of Google Cloud Functions. This API might be changed in backward-incompatible ways and is not subject to any SLA or deprecation policy._
88

9-
npm install firebase-functions
9+
10+
## Learn more
11+
12+
Learn more about the Firebase SDK for Cloud Functions in the [Firebase documentation](https://firebase.google.com/docs/functions/) or [check out our samples](https://github.com/firebase/functions-samples).
1013

1114
## Usage
1215

@@ -24,3 +27,11 @@ exports.newPost = functions.database
2427
}
2528
});
2629
```
30+
31+
## Contributing
32+
33+
To contribute a change, [check out the contributing guide](CONTRIBUTING.md).
34+
35+
## License
36+
37+
© Google, 2017. Licensed under [The MIT License](LICENSE).

0 commit comments

Comments
 (0)