Skip to content

Commit

Permalink
docs: Updated README.md and added CONTRIBUTING.md (#355)
Browse files Browse the repository at this point in the history
* docs: Updated README.md

* Added contributing mdx file
  • Loading branch information
Shubhdeep12 authored Feb 22, 2024
1 parent 2d37041 commit 6f29383
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Refer to [Contribute to Spotlight](https://spotlightjs.com/contribute/)
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/)
<p align="center">
<a href="https://blog.sentry.io/sentry-for-development/" target="_blank">
<img src="https://raw.githubusercontent.com/getsentry/spotlight/main/.github/spotlight-hero-v2.jpg?utm_source=github&utm_medium=logo" alt="Spotlight">
</a>
</p>

# 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/)

0 comments on commit 6f29383

Please sign in to comment.