Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
peel committed Nov 21, 2024
1 parent 4f679d9 commit cbe0bfc
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,39 +6,38 @@

## Introduction

Stream Collector receives raw [Snowplow][snowplow] events sent over HTTP by trackers or webhooks. It serializes them to a [Thrift][thrift] record format, and then writes them to one of supported sinks like [Amazon Kinesis][kinesis], [Google PubSub][pubsub], [Apache Kafka][kafka], [Amazon SQS][sqs], [NSQ][nsq].
The Stream Collector supports cross-domain Snowplow deployments, setting a user_id (used to identify unique visitors) server side to reliably identify the same user across domains.
Stream Collector receives raw [Snowplow][snowplow] events sent over HTTP by trackers or webhooks. It serializes them to a [Thrift][thrift] record format, and then writes them to one of the supported sinks like [Amazon Kinesis][kinesis], [Google PubSub][pubsub], [Apache Kafka][kafka], [Amazon SQS][sqs], [NSQ][nsq].
The Stream Collector supports cross-domain Snowplow deployments, setting a `user_id` (used to identify unique visitors) server side to reliably identify the same user across domains.

## Find out more

| Technical Docs | Setup Guide | Roadmap | Contributing |
|----------------------------|----------------------|-----------------------------|---------------------------|
| ![i1][techdocs-image] | ![i2][setup-image] | ![i3][roadmap-image] | ![i4][contributing-image] |
| [Technical Docs][techdocs] | [Setup Guide][setup] | [Snowplow Roadmap][roadmap] | _coming soon_ |
| Technical Docs | Setup Guide | Contributing |
|----------------------------|----------------------|------------------------------|
| ![i1][techdocs-image] | ![i2][setup-image] | ![i4][contributing-image] |
| [Technical Docs][techdocs] | [Setup Guide][setup] | [Contributing][contributing] |

## Copyright and license

Copyright (c) 2023-present Snowplow Analytics Ltd. All rights reserved.

Licensed under the [Snowplow Limited Use License Agreement][license]. _(If you are uncertain how it applies to your use case, check our answers to [frequently asked questions][faq].)_

[snowplow]: http://snowplowanalytics.com
[snowplow]: https://snowplow.io/

[thrift]: http://thrift.apache.org
[kinesis]: http://aws.amazon.com/kinesis
[pubsub]: https://cloud.google.com/pubsub/
[kafka]: http://kafka.apache.org
[sqs]: https://aws.amazon.com/sqs/
[nsq]: http://nsq.io/

[techdocs-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/techdocs.png
[setup-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/setup.png
[roadmap-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/roadmap.png
[contributing-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/contributing.png

[techdocs]: https://docs.snowplowanalytics.com/docs/pipeline-components-and-applications/stream-collector/
[setup]: https://docs.snowplowanalytics.com/docs/getting-started-on-snowplow-open-source/
[roadmap]: https://github.com/snowplow/snowplow/projects/7
[contributing]: https://docs.snowplowanalytics.com/docs/contributing/
[techdocs]: https://docs.snowplow.io/docs/pipeline-components-and-applications/stream-collector/
[setup]: https://docs.snowplow.io/docs/getting-started-on-community-edition/
[contributing]: https://docs.snowplow.io/docs/contributing/

[build-image]: https://github.com/snowplow/stream-collector/workflows/build/badge.svg
[build-wf]: https://github.com/snowplow/stream-collector/actions?query=workflow%3Abuild
Expand Down

0 comments on commit cbe0bfc

Please sign in to comment.