Skip to content

Commit a0d95bd

Browse files
authored
Explain repo purpose in README
See #96
1 parent 82a7449 commit a0d95bd

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,18 @@
33
This repository holds code snippets used in Web documentation
44
on [firebase.google.com](https://firebase.google.com/docs/).
55

6+
These snippets are part of our documentation and best read in the context of a documentation page rather than used directly. If you're looking to get started with the Firebase Web SDK the best place to start is [quicstart-web](https://github.com/firebase/quickstart-web).
7+
8+
## Example
9+
10+
Consider this page:
11+
https://firebase.google.com/docs/database/web/lists-of-data
12+
13+
Each snippet in the page is dynamically included from the source in this repository, in this case mostly from this file:
14+
https://github.com/firebase/snippets-web/blob/master/database/lists-of-data.js
15+
16+
Each snippet has a "region tag" which is defined by `// [START tag]` and `// [END tag]` comments. The code between the tags can be included in our documentation. Keeping the code on GitHub, rather than hard-coded into the HTML of our documentation, allows us to ensure the code is correct and up to date.
17+
618
## Contributing
719

820
We love contributions! See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.

0 commit comments

Comments
 (0)