Skip to content

Update README.md #528

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #528

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
80 changes: 20 additions & 60 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,84 +6,44 @@

# Open-source event data collection and tag management

[Read docs](https://elbwalker.com/docs) ·
[Play with the demo](https://elbwalker.com/playground) ·
[Request Feature](https://github.com/elbwalker/walkerOS/issues/new) ·
[Report Bug](https://github.com/elbwalker/walkerOS/issues/new) ·
[Say hello](https://calendly.com/elb-alexander/30min)

<div align="left">
<img src="https://img.shields.io/github/license/elbwalker/walkerOS" />
<a href="https://www.elbwalker.com/docs/"><img src="https://img.shields.io/badge/docs-www.elbwalker.com/docs/-yellow" alt="walkerOS Documentation"></a>
<a href="https://github.com/elbwalker/walkerOS/tree/main/apps/demos/react"><img src="https://img.shields.io/badge/React_demo-blue" alt="React demo"></a>

</div>

# What is walkerOS
# Why walkerOS?

walkerOS is a privacy-centric event data collection platform. It offers features
like data
capturing, [consent management](https://www.elbwalker.com/docs/consent_management/overview/), data
integration, and [tag management](https://www.elbwalker.com/docs/destinations/event_mapping). Fully configurable as code.
- **Full data ownership**: Your data stays yours. No vendor lock-in, no third-party dependencies, complete control over how data is captured, processed and shared.
- **Scalable tagging**: DOM-based, component-level frontend tagging makes tracking declarative, reusable, and easy to maintain.
- **Privacy-first by design**: Built-in consent handling and privacy controls help you meet compliance from day one.
- **Tag management as code**: Replace complex UIs with clean, version-controlled tracking logic.

The project started as a web
library called&nbsp;<Link to="/docs/sources/walkerjs/">walker.js</Link> and has
evolved into a complete first-party tracking system.

## Packages Overview
## Packages overview

- **Sources** ([docs](https://www.elbwalker.com/docs/sources/),
[code](./packages/sources/)): For data creation and state management.
- **Collectors**: ([docs](https://www.elbwalker.com/docs/collectors/),
[code](./packages/collectors/)): For client- or server-side data collection.
- **Sources** ([docs](https://www.elbwalker.com/docs/sources/)): For data creation and state management.
- **Destinations** ([docs](https://www.elbwalker.com/docs/destinations/),
[code](./packages/destinations/)): Initialize, map and share events to
third-party tools.
- **Utils** ([docs](https://www.elbwalker.com/docs/utils/),
[code](./packages/utils/)): Enhance data collection with shared utilities.

## Why walkerOS?

- **Sustainability**: Robust infrastructure for continuous data collection,
even amidst evolving data landscapes.
- **Privacy focus**: Strict privacy-by-design
approach, in-build consent
management</Link> and various data protection features.
- **Complete data ownership**: Full control of your first-party data,
no vendor lock-in, and control of data processing.
- **Simplified data model**: Intuitive event model that streamlines data
collection, making analytics straightforward and efficient.
- **Flexible architecture**: Modular design adapting to your specific data needs and allows growing step-by-step.

## How walkerOS operates

```mermaid
---
title: Basic infrastructure
---
flowchart LR
subgraph walkerOS
direction LR
subgraph Collection
Sources
end
subgraph Activation
Destinations
end
%%Utils
end
subgraph Tools
direction LR
storage["Storage"]
marketing["Marketing"]
analytics["Analytics"]
end
Sources --> Destinations
Destinations --> Tools
```


## How it works

![250707 walkerOS event flow](https://github.com/user-attachments/assets/f4dab4a6-8355-4bb3-9638-5775766ba313)

Comment on lines +37 to 40
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Diagram link is ephemeral – prefer a repo-local asset
user-attachments links break once the GitHub comment is deleted or the token expires. Store the image under docs/assets/ (or similar) and reference it relatively to guarantee longevity.

🤖 Prompt for AI Agents 
In README.md around lines 37 to 40, the image link uses an ephemeral GitHub
user-attachments URL that can break over time. To fix this, download the image
and store it in a local directory such as docs/assets/, then update the markdown
to reference the image using a relative path to ensure the image remains
accessible permanently.

## Installation

Start collecting data with our
[web](https://github.com/elbwalker/walkerOS/tree/main/packages/sources/walkerjs)
or [node](https://github.com/elbwalker/walkerOS/tree/main/packages/sources/node)
source.
Start collecting data
[client-side](https://github.com/elbwalker/walkerOS/tree/main/packages/sources/walkerjs)
or [server-side](https://github.com/elbwalker/walkerOS/tree/main/packages/sources/node)
by installing a collector.

## Contributing

Expand Down