Add README

CODE_OF_CONDUCT.md

@@ -0,0 +1,39 @@
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [hey@openreplay.com](mailto:hey@openreplay.com). The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version 1.4, available at [https://contributor-covenant.org/version/1/4](https://contributor-covenant.org/version/1/4/)

CONTRIBUTING.md

@@ -0,0 +1,74 @@
+We're glad you're considering contributing to OpenReplay. Each and every contribution is highly appreciated. Don't worry if you're not sure how to get things started. Although we don't want a wall of rules to stand in the way of your contribution, this document should give a bit more guidance on the best way to proceed. If you still have questions, reach out for help.
+
+## Code of Conduct
+
+By participating in this project, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## First-time Contributors
+
+We appreciate all contributions, especially those coming from first time contributors. Good first issues is the best way start. If you're not sure how to help, feel free to reach out anytime for assistance via [email](mailto:hey@openreplay.com) or [Slack](https://slack.openreplay.com).
+
+## Areas for Contributing
+
+### Documentation
+
+We want to keep our docs comprehensive, concise and updated. We are grateful for any kind of contribution in this area:
+- Report missing sections
+- Fix errors in existing docs
+- Add content to the docs
+
+### Community Content
+
+We're happy about contributions that participate in educating our community, such as:
+- Writing technical blog post
+- Adding new user guides
+- Organizing a workshop
+- Speaking at an event
+
+We have a repo dedicated to community content. Feel free to submit a pull request in this repo, if you have something to add even if it's not related to what's mentioned above.
+
+### OpenReplay Core
+
+We have some issues on core components that are suitable for open source contributions. If you know Go or JavaScript, check out our issue list.
+
+## Ways to Contribute
+
+### Writing Code
+
+We love all code contributions, big or small. A few things to keep in mind:
+
+- Please make sure there is an issue associated with what you're working on
+- If you're tackling an issue, please comment on that to prevent duplicate work by others
+- We follow the [fork-and-branch](https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/) approach
+- Squash your commits and refer to the issue using `fix #<issue-no>` in the commit message
+- Rebase master with your branch before submitting a pull request.
+
+If you're planning to work on a bigger feature that is not on the list of issues, please raise an issue first so we can check whether it makes sense for OpenReplay as a whole.
+
+Check our Review Process below.
+
+### Reporting Bugs
+
+Bug reports help us make OpenReplay better for everyone. Before raising a new issue:
+- Search within the list of reported bugs so you're not dealing with a duplicate
+- Make sure you test against the last released version (we may have fixed it already)
+- Provide clear steps to reproduce the issue and attach logs if relevant
+
+### Reporting Security Flaws
+
+Please do not create a public GitHub issue. If you find a security flaw, please email us directly at [security@openreplay.com](mailto:security@openreplay.com) instead of raising an issue.
+
+### Upvoting Issues and Requesting Features
+
+Upvoting issues and requesting new features is the best way to tell us what you'd like us to build and helps prioritize our efforts. Don't refrain from doing that but make sure to watch out for duplicates by looking at the feature-request list.
+
+## Review Process
+
+We try to answer the below questions when reviewing a PR:
+- Does the PR fix the issue?
+- Does the proposed solution makes sense?
+- How will it perform with millions of sessions and users events?
+- Has it been tested?
+- Is it introducing any security flaws?
+
+Once your PR passes, we will merge it. Otherwise, we'll politely ask you to make a change.

README.md

@@ -1,2 +1,86 @@
-# openreplay
-Asayer is developer-friendly, open-source session replay.
+<p align="center">
+  <a href="https://openreplay.com">
+    <img src="static/logo.svg">
+  </a>
+</p>
+
+<h3 align="center">Session replay for developers</h3>
+<p align="center">The most advanced open-source session replay to improve web apps.</p>
+
+<p align="center">
+  <a href="https://marketplace.digitalocean.com/apps/asayer">
+    <img src="https://assets.strapi.io/uploads/deploy_button_Digital_Ocean_fe2c286222.png" />
+  </a>
+
+  <a href="https://www.heroku.com/deploy/?template=https://github.com/asayer/asayer-heroku-template">
+    <img src="https://assets.strapi.io/uploads/Deploy_button_heroku_b1043fc67d.png" />
+  </a>
+
+  <a href="https://render.com/docs/deploy-asayer">
+    <img src="https://assets.strapi.io/uploads/deploy_render_e076b6f23a.png" height="44" />
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://openreplay.com">
+    <img src="static/replayer.png">
+  </a>
+</p>
+
+OpenReplay is a session replay stack that let's you see what users do on your web app, helping you troubleshoot issues faster. It's the only open-source alternative to products such as FullStory, LogRocket or Hotjar.
+
+- **Session replay.** OpenReplay replays what users do, but not only. It also shows you what went under the hood, how your website or app behaves by capturing network activity, console logs, JS errors, store actions/state, page speed metrics, cpu/memory usage and much more.
+- **Low footprint**. With a ~16KB (.gz) tracker that asynchronously sends minimal data for a very limited impact on performance.
+- **Self-hosted**. No more security compliance checks, 3rd-parties processing user data. Everything OpenReplay captures stays in your cloud for a complete control over your data.
+- **Privacy controls**. Fine-grained security features for sanitizing user data.
+- **Easy deploy**. With support of major public cloud providers (AWS, GCP, Azure, DigitalOcean).
+
+## Features
+
+- **Session replay:** Lets you relive your users' experience, see where they struggle and how it affects their behavior. Each session replay is automatically analyzed based on heuristics, for easy triage.
+- **Omni-search:** Search and filter by almost any user action/criteria, session attribute or technical event, so you can answer any question. No instrumentation required.
+- **Funnels:** For surfacing the most impactful issues causing conversion and revenue loss.
+- **DevTools:** It's like debugging in your own browser. OpenReplay provides you with the full context so you can instantly reproduce bugs and understand performance issues.
+- **Error tracking:** JS errors are captured and sync'ed with session replays. Upload your source-maps and see the source code right in the stack trace.
+- **Performance metrics:** Ready-to-use dashboard with 40+ metrics to keep an eye on your web app's performance. Alerts keep you notified when critical slowdowns occur.
+- **Fine-grained privacy controls:** Choose what to capture, what to obscure or what to ignore so user data doesn't even reach your servers.
+- **Plugins oriented:** Get to the root cause even faster by tracking application state (Redux, VueX, MobX, NgRx) and logging GraphQL queries (Apollo, Relay) and Fetch requests.
+- **Integrations:** Sync your backend logs with your session replays and see what happened front-to-back. OpenReplay supports Sentry, Datadog, CloudWatch, Stackdriver, Elastic and more.
+
+## Deployment Options
+
+OpenReplay can be deployed anywhere. Follow our step-by-step guides for deploying it on major public clouds:
+
+- AWS
+- Google Cloud
+- Microsoft Azure
+- Kubernetes
+
+## OpenReplay Cloud
+
+For those who want to simply use OpenReplay as a service, [sign up](https://asayer.io/register.html) for a free account on our cloud offering.
+
+## Community Support
+
+Please refer to the [official OpenReplay documentation](https://docs.openreplay.com/). That should help you troubleshoot common issues. For additional help, you can reach out to us on one of these channels:
+
+- [Slack](https://slack.openreplay.com) (Connect with our engineers and community)
+- [GitHub](https://github.com/openreplay) (Bug and issue reports)
+- [Twitter](https://twitter.com/OpenReplayHQ) (Product updates, Great content)
+- [Website chat](https://openreplay.com) (Talk to us)
+
+## Contributing
+
+We're always on the lookout for contributions to OpenReplay, and we're glad you're considering it! Not sure where to start? Look for open issues, preferably those marked as good first issues.
+
+See our [Contributing Guide](CONTRIBUTING.md) for more details.
+
+Also, feel free to join our [Slack](https://slack.openreplay.com) to ask questions, discuss ideas or connect with our  contributors.
+
+## Roadmap
+
+Check out our roadmap and keep an eye on what's coming next. You're free to submit new ideas and vote on features.
+
+## License
+
+This repo is entirely MIT licensed, with the exception of the `ee` directory.

SECURITY.md

@@ -0,0 +1,9 @@
+## Reporting Vulnerabilities
+
+We're extremely grateful to those who report vulnerabilities to the OpenReplay Community. All security issues should be directly addressed to us at [security@openreplay.com](mailto:security@openreplay.com) with the necessary details.
+Don't hesitate to submit potential vulnerabilities you discovered in OpenReplay, or in any of its dependencies. If also better to do so even if you're not sure how the issue affects OpenReplay.
+
+## Security Vulnerability Response
+
+Every report is thoroughly investigated by our community volunteers and the OpenReplay team.
+You will receive a response from us within 3 working days. If the issue is confirmed, we will release a patch as soon as we can depending on the mitigation complexity. We will you keep you updated during the entirety of the process. The bug will be publicly disclosed right after the solution is available and well tested.