Skip to content

Commit a50633f

Browse files
authored
Merge pull request #1 from bufferapp/JustinaPetr-patch-1
Revise README for clarity and additional details
2 parents 2f80a28 + c4e20af commit a50633f

1 file changed

Lines changed: 58 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 58 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,58 @@
1-
# buffer-sample-apps
2-
A repository for sample apps build using Buffer API
1+
# Buffer Sample Apps
2+
A collection of sample applications that show how to build on the Buffer API. Each sample is a small, self-contained project you can clone, run, and use as a starting point for your own build.
3+
4+
> **Note:** These samples are meant for learning and prototyping. Make sure to review and adapt them to your own security, error-handling, and scaling needs before using them in production.
5+
6+
### Prerequisites
7+
8+
- A [Buffer](https://buffer.com) account
9+
- API access credentials - see the [Buffer developer docs](https://developers.buffer.com/guides/authentication.html) for how to get them
10+
- Any language-specific tooling listed in the sample's own README
11+
12+
## Repository structure
13+
14+
Each sample app lives in its own folder with everything it needs to run:
15+
16+
```
17+
.
18+
├── sample-app-name/
19+
│ ├── README.md # Setup and usage instructions for this sample
20+
│ ├── .env.example # Environment variables the sample needs
21+
│ └── ... # Source code
22+
├── another-sample/
23+
│ └── ...
24+
├── LICENSE
25+
└── README.md
26+
```
27+
28+
### Run a sample app
29+
30+
1. Clone the repository:
31+
```bash
32+
git clone https://github.com/bufferapp/buffer-sample-apps.git
33+
cd buffer-sample-apps
34+
```
35+
36+
2. Move into the sample you want to try:
37+
```bash
38+
cd sample-app-name
39+
```
40+
41+
3. Follow the setup instructions in that sample's `README.md`.
42+
Never commit your API credentials. Each sample reads them from environment variables - copy `.env.example` to `.env` and fill in your own values.
43+
44+
45+
## Resources
46+
47+
- [Buffer developer docs](https://developers.buffer.com)
48+
- [Buffer Help Center](https://support.buffer.com)
49+
50+
## Contributing
51+
52+
These sample apps are provided as-is for educational purposes. They're maintained on a best-effort basis and aren't covered by Buffer's product support or service-level agreements.
53+
54+
We welcome issues and suggestions for improvements. If you spot a bug or have an idea for a new sample, please [open an issue](../../issues). At the moment we don't accept direct contributions of new samples.
55+
56+
## License
57+
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
58+

0 commit comments

Comments
 (0)