Skip to content

docs: add guide links to the readme #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amir78729 merged 2 commits into from
Feb 16, 2026
Merged

docs: add guide links to the readme #16

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
642705e
docs: add guide links to the readme
amir78729 Feb 16, 2026
a06e2c1
docs: add guide links to the readme
amir78729 Feb 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ type ClientConfig struct {
```

Configuration validation:

- `FlushInterval` must be positive if provided
- `MaxBatchSize` must be positive if provided
- `MaxRetries` must be non-negative if provided
Expand Down Expand Up @@ -140,11 +141,13 @@ Note: `Track()` automatically calls `Init()`, so explicit initialization is opti
Tracks an event with optional payload and metadata.

Parameters:

- `name` - Event name/identifier (required, cannot be empty)
- `payload` - Event data payload (optional, pass `nil` if not needed)
- `metadata` - Event-specific metadata (optional, pass `nil` if not needed)

Usage examples:

- `Track("page_view", nil, nil)` - Simple event tracking
- `Track("click", map[string]any{"button": "submit"}, nil)` - Event with payload
- `Track("purchase", payload, map[string]any{"version": "1.0"})` - Event with payload and metadata
Expand Down Expand Up @@ -227,10 +230,10 @@ go func() {

## Logger Adapters

| Adapter | Output | Configurable | Use Case |
| ------------------------ | ------- | ------------ | --------------------------- |
| **PrintLoggerAdapter** | Stdout | Yes | Development and debugging |
| **NoOpLoggerAdapter** | None | No | Production (silent logging) |
| Adapter | Output | Configurable | Use Case |
| ---------------------- | ------ | ------------ | --------------------------- |
| **PrintLoggerAdapter** | Stdout | Yes | Development and debugging |
| **NoOpLoggerAdapter** | None | No | Production (silent logging) |

### Log Levels

Expand All @@ -251,6 +254,9 @@ client, err := ripple.NewClient(ripple.ClientConfig{

## Storage Adapters

| Adapter | Capacity | Persistence | Use Case |
| ---------------------- | --------- | ----------- | --------------------------------- |
| **NoOpStorageAdapter** | N/A | None | Default, no persistence |
| Adapter | Capacity | Persistence | Use Case |
| ---------------------- | --------- | ----------- | --------------------------------- |
| **NoOpStorageAdapter** | N/A | None | Default, no persistence |
Expand Down Expand Up @@ -288,10 +294,6 @@ For custom storage implementations (e.g., file, Redis, database), implement the

See [AGENTS.md](./AGENTS.md) for detailed architecture documentation.

## API Contract

See the [API Contract Documentation](https://github.com/Tap30/ripple/blob/main/DESIGN_AND_CONTRACTS.md) for the shared interface all Ripple SDKs follow.

## Development

```bash
Expand All @@ -313,6 +315,16 @@ cd playground && make server
cd playground && make client
```

## Guides

- [Security Best Practices](https://github.com/Tap30/ripple/blob/main/guides/SECURITY.md)
- [Disaster Recovery](https://github.com/Tap30/ripple/blob/main/guides/DISASTER_RECOVERY.md)
- [Performance Tuning](https://github.com/Tap30/ripple/blob/main/guides/PERFORMANCE_TUNING.md)

## Design and API Contract

Read the [Design and API Contract Documentation](https://github.com/Tap30/ripple/blob/main/DESIGN_AND_CONTRACTS.md) to learn about the framework-agnostic API contract for SDKs.

## Contributing

See the [contributing guide](https://github.com/Tap30/ripple-go/blob/main/CONTRIBUTING.md).
Expand Down
Loading