Skip to content

Commit 7467017

Browse files
authored
chore: Create README template
1 parent 77eb5c3 commit 7467017

1 file changed

Lines changed: 64 additions & 0 deletions

File tree

README-template.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# New README Template
2+
3+
## Description
4+
5+
This is a sample README file with the recommended sections for new libraries in the github.com/googlemaps organization. This is where you would write a single-sentence description of the project.
6+
7+
## Requirements
8+
9+
Pre-requisites listed here
10+
11+
## Installation
12+
13+
Installation guidance here. Where should the installation code be inserted?
14+
15+
```
16+
Installation code snippet
17+
```
18+
19+
## Sample App
20+
21+
Link to the same app that demonstrates this library, if it exists (often a folder within the repo).
22+
23+
## Documentation
24+
25+
Link to full documentation for the library.
26+
27+
## Usage
28+
29+
### Feature 1 Heading
30+
31+
Description of feature 1.
32+
33+
```
34+
Feature 1 sample code
35+
```
36+
37+
</details>
38+
39+
<details>
40+
<summary>Feature 2 title</summary>
41+
42+
### Feature 2 title
43+
44+
This demonstrates hiding a long feature section behind an expandable. If using expandables, it would be best to put all but the first most basic sample in expandables.
45+
46+
```javascript
47+
Feature 2 sample code
48+
```
49+
50+
</details>
51+
52+
## Contributing
53+
54+
If contributions are accepted, link to the Contributing.md guide.
55+
56+
## Support
57+
58+
Encounter an issue while using this library?
59+
60+
If you find a bug or have a feature request, please [file an issue]().
61+
Or, if you'd like to contribute, send us a [pull request]() and refer to our [code of conduct]().
62+
63+
You can also discuss this library on our [Discord server](https://discord.gg/hYsWbmk).
64+

0 commit comments

Comments
 (0)