Skip to content

Commit b94d1aa

Browse files
authored
meta(readme): Update the beta disclaimer (#56)
1 parent e77dca3 commit b94d1aa

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,14 @@
1010
[![Build Status](https://travis-ci.org/getsentry/sentry-rust.svg?branch=master)](https://travis-ci.org/getsentry/sentry-rust)
1111
[![Crates.io](https://img.shields.io/crates/v/sentry.svg?style=flat)](https://crates.io/crates/sentry)
1212

13-
This is a new work in progress Sentry library. It will eventually be published to
14-
crates.io as `sentry`. At the moment the crate on creates.io is an older and
15-
incompatible version of this crate.
13+
This crate provides support for logging events and errors / panics to the
14+
[Sentry](https://sentry.io/) error logging service. It integrates with the
15+
standard panic system in Rust as well as a few popular error handling setups.
16+
17+
**Note**: Until the _1.0_ release, the `sentry` crate is considered work in
18+
progress and does not follow semver semantics. Between minor releases, we might
19+
occasionally introduce breaking changes while we are exploring the best API and
20+
adding new features.
1621

1722
## Requirements
1823

@@ -24,8 +29,8 @@ Additionally, the lowest Rust version we target is _1.24.0_.
2429

2530
## Resources
2631

27-
* [crates.io](https://crates.io/crates/sentry)
28-
* [Documentation](https://docs.rs/sentry)
29-
* [Bug Tracker](https://github.com/getsentry/sentry-rust/issues)
30-
* [IRC](irc://chat.freenode.net/sentry) (chat.freenode.net, #sentry)
31-
* Follow [@getsentry](https://twitter.com/getsentry) on Twitter for updates
32+
- [crates.io](https://crates.io/crates/sentry)
33+
- [Documentation](https://docs.rs/sentry)
34+
- [Bug Tracker](https://github.com/getsentry/sentry-rust/issues)
35+
- [IRC](irc://chat.freenode.net/sentry) (chat.freenode.net, #sentry)
36+
- Follow [@getsentry](https://twitter.com/getsentry) on Twitter for updates

0 commit comments

Comments
 (0)