Skip to content
This repository was archived by the owner on Sep 19, 2025. It is now read-only.

Commit ebab334

Browse files
authored
Update README.md
1 parent efe9e93 commit ebab334

File tree

1 file changed

+1
-54
lines changed

1 file changed

+1
-54
lines changed

README.md

Lines changed: 1 addition & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1 @@
1-
## ⚠️ Security Warning
2-
3-
**Keep your API credentials secure!**
4-
5-
- The `<API_KEY>` and `<API_SECRET>` are sensitive credentials that grant access to your application’s PulseBeam resources. **Do not expose these credentials** in:
6-
- Public repositories.
7-
- Client-side code.
8-
- Shared or unencrypted environments.
9-
10-
- Treat tokens generated by this CLI as sensitive data. Tokens should only be shared with trusted clients.
11-
12-
### Recommended Practices:
13-
1. **Environment Variables:** Store your API credentials securely in environment variables instead of hardcoding them in your codebase.
14-
```bash
15-
export PULSEBEAM_API_KEY="your_api_key"
16-
export PULSEBEAM_API_SECRET="your_api_secret"
17-
```
18-
19-
2. **Access Controls:** Regularly rotate API credentials and limit their scope to only necessary permissions.
20-
21-
3. **Auditing:** Monitor usage of your credentials and investigate any unauthorized activity.
22-
23-
## 💳 Billing and Token Usage
24-
25-
**Be aware:** Generating and using tokens can incur billing charges. Each token enables interactions with PulseBeam's infrastructure, which may contribute to your account’s usage costs.
26-
27-
### Billing Best Practices:
28-
1. **Understand Your Plan:** Familiarize yourself with the details of your billing plan. For more information, visit our [Billing Page](https://pulsebeam.dev/billing).
29-
2. **Monitor Usage:** Keep track of token usage to avoid unexpected charges. Utilize PulseBeam’s dashboards and APIs for real-time monitoring.
30-
3. **Token Expiration:** Set appropriate `duration` values for tokens to limit unnecessary usage. Tokens with a longer duration may result in increased billing if misused.
31-
4. **Audit Token Distribution:** Ensure tokens are only distributed to trusted clients to avoid misuse that could drive up costs.
32-
33-
### ⚠️ Important Billing Warning
34-
35-
- Tokens allow access to PulseBeam's infrastructure and **may result in charges depending on your usage**.
36-
- Misuse or unauthorized distribution of tokens can lead to **unexpected billing costs**.
37-
- **Ensure you monitor your account's activity regularly** and revoke tokens that are no longer needed.
38-
39-
For detailed information on billing and usage policies, visit our [Billing Page](https://pulsebeam.dev/billing).
40-
41-
42-
## Status
43-
44-
> [!WARNING]
45-
> This SDK is currently in **Developer Preview**. During this phase:
46-
> - APIs are subject to breaking changes
47-
> - Stability issues may occur
48-
> - Core functionality is still being validated
49-
>
50-
> **We value your input!**
51-
> Report bugs, suggest improvements, or collaborate directly with our team:
52-
>
53-
> • [Create GitHub Issues](https://github.com/PulseBeamDev/pulsebeam-core/issues)
54-
> • [Join PulseBeam Developer Discord](https://discord.gg/Bhd3t9afuB)
1+
## Move to pulsebeam monorepo, https://github.com/PulseBeamDev/pulsebeam

0 commit comments

Comments
 (0)