From 6f2938323b163e1925a9b65f6e0b58d70f9363c1 Mon Sep 17 00:00:00 2001 From: Shubhdeep Chhabra Date: Thu, 22 Feb 2024 18:15:55 +0530 Subject: [PATCH] docs: Updated README.md and added CONTRIBUTING.md (#355) * docs: Updated README.md * Added contributing mdx file --- CONTRIBUTING.md | 1 + README.md | 23 ++++++++++++++++++++--- 2 files changed, 21 insertions(+), 3 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..ede77350 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1 @@ +Refer to [Contribute to Spotlight](https://spotlightjs.com/contribute/) diff --git a/README.md b/README.md index 09625a93..e548b2c4 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,25 @@ -[![Spotlight](https://raw.githubusercontent.com/getsentry/spotlight/main/.github/spotlight-hero-v2.jpg?utm_source=github&utm_medium=logo)](https://blog.sentry.io/sentry-for-development/) +

+ + Spotlight + +

+# What's Spotlight? [![npm version](https://img.shields.io/npm/v/@spotlightjs/spotlight.svg)](https://www.npmjs.com/package/@spotlightjs/spotlight) Spotlight is Sentry for Development. Inspired by an old project, Django Debug Toolbar, Spotlight brings a rich debug overlay into development environments, and it does it by leveraging the existing power of Sentry's SDKs. -For more information, see our [documentation](https://spotlightjs.com/about/). -See [Contribute](https://spotlightjs.com/contribute/) for how to contribute and develop against Spotlight. +## Links + +- [![Documentation](https://img.shields.io/badge/documentation-spotlight-indigo.svg)](https://spotlightjs.com/about/) +- [![Discord](https://img.shields.io/discord/621778831602221064)](https://discord.gg/Ww9hbqr) +- [![Stack Overflow](https://img.shields.io/badge/stack%20overflow-sentry-green.svg)](http://stackoverflow.com/questions/tagged/sentry) +- [![Twitter Follow](https://img.shields.io/twitter/follow/getsentry?label=getsentry&style=social)](https://twitter.com/intent/follow?screen_name=getsentry) + +## Resources + +- [Contribute](https://spotlightjs.com/contribute/) +- [Setup Spotlight](https://spotlightjs.com/setup/) +- [Sidecar](https://spotlightjs.com/sidecar/) +- [Integrations](https://spotlightjs.com/integrations/) +