Browse Source

meta(readme): Switch to markdown for better compatibility (#16301)

Burak Yigit Kaya 5 years ago
parent
commit
2235f58ba5
3 changed files with 51 additions and 54 deletions
  1. 49 0
      README.md
  2. 0 53
      README.rst
  3. 2 1
      setup.py

+ 49 - 0
README.md

@@ -0,0 +1,49 @@
+<p align="center">
+  <p align="center">
+    <a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
+      <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" alt="Sentry" height="72">
+    </a>
+  </p>
+  <p align="center">
+    Users and logs provide clues. Sentry provides answers.
+  </p>
+</p>
+
+# What's Sentry?
+
+Sentry fundamentally is a service that helps you monitor and fix crashes
+in realtime. The server is in Python, but it contains a full API for
+sending events from any language, in any application.
+
+<p align="center">
+  <img src="https://github.com/getsentry/sentry/raw/master/src/sentry/static/sentry/images/product/thumb-1.png" width="290">
+  <img src="https://github.com/getsentry/sentry/raw/master/src/sentry/static/sentry/images/product/thumb-2.png" width="290">
+  <img src="https://github.com/getsentry/sentry/raw/master/src/sentry/static/sentry/images/product/thumb-3.png" width="290">
+</p>
+
+## Official Sentry SDKs
+
+  - [JavaScript](https://github.com/getsentry/sentry-javascript)
+  - [React-Native](https://github.com/getsentry/react-native-sentry)
+  - [Python](https://github.com/getsentry/sentry-python)
+  - [Ruby](https://github.com/getsentry/raven-ruby)
+  - [PHP](https://github.com/getsentry/sentry-php)
+  - [Go](https://github.com/getsentry/sentry-go)
+  - [Java](https://github.com/getsentry/sentry-java)
+  - [Objective-C/Swift](https://github.com/getsentry/sentry-cocoa)
+  - [C\#](https://github.com/getsentry/sentry-dotnet)
+  - [Perl](https://github.com/getsentry/perl-raven)
+  - [Elixir](https://github.com/getsentry/sentry-elixir)
+  - [Laravel](https://github.com/getsentry/sentry-laravel)
+
+# Resources
+
+  - [Documentation](https://docs.sentry.io/)
+  - [Community](https://forum.sentry.io/) (Bugs, feature requests,
+    general questions)
+  - [Contributing](https://docs.sentry.io/internal/contributing/)
+  - [Bug Tracker](https://github.com/getsentry/sentry/issues)
+  - [Code](https://github.com/getsentry/sentry)
+  - [Discord](https://discord.gg/ez5KZN7)
+  - [Transifex](https://www.transifex.com/getsentry/sentry/) (Translate
+    Sentry\!)

+ 0 - 53
README.rst

@@ -1,53 +0,0 @@
-.. raw:: html
-
-   <p align="center">
-     <p align="center">
-       <a href="https://sentry.io/?utm_source=github&utm_medium=logo" target="_blank">
-         <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" alt="Sentry" height="72">
-       </a>
-     </p>
-     <p align="center">
-       Users and logs provide clues. Sentry provides answers.
-     </p>
-   </p>
-
-What's Sentry?
---------------
-
-Sentry fundamentally is a service that helps you monitor and fix crashes in realtime.
-The server is in Python, but it contains a full API for sending events from any
-language, in any application.
-
-.. raw:: html
-
-   <p align="center">
-     <img src="https://github.com/getsentry/sentry/raw/master/src/sentry/static/sentry/images/product/thumb-1.png" width="290">
-     <img src="https://github.com/getsentry/sentry/raw/master/src/sentry/static/sentry/images/product/thumb-2.png" width="290">
-     <img src="https://github.com/getsentry/sentry/raw/master/src/sentry/static/sentry/images/product/thumb-3.png" width="290">
-   </p>
-
-Official Sentry SDKs
-~~~~~~~~~~~~~~~~~~~~
-* `JavaScript <https://github.com/getsentry/sentry-javascript>`_
-* `React-Native <https://github.com/getsentry/react-native-sentry>`_
-* `Python <https://github.com/getsentry/sentry-python>`_
-* `Ruby <https://github.com/getsentry/raven-ruby>`_
-* `PHP <https://github.com/getsentry/sentry-php>`_
-* `Go <https://github.com/getsentry/sentry-go>`_
-* `Java <https://github.com/getsentry/sentry-java>`_
-* `Objective-C/Swift <https://github.com/getsentry/sentry-cocoa>`_
-* `C# <https://github.com/getsentry/sentry-dotnet>`_
-* `Perl <https://github.com/getsentry/perl-raven>`_
-* `Elixir <https://github.com/getsentry/sentry-elixir>`_
-* `Laravel <https://github.com/getsentry/sentry-laravel>`_
-
-Resources
----------
-
-* `Documentation <https://docs.sentry.io/>`_
-* `Community <https://forum.sentry.io/>`_ (Bugs, feature requests, general questions)
-* `Contributing <https://docs.sentry.io/internal/contributing/>`_
-* `Bug Tracker <https://github.com/getsentry/sentry/issues>`_
-* `Code <https://github.com/getsentry/sentry>`_
-* `Discord <https://discord.gg/ez5KZN7>`_
-* `Transifex <https://www.transifex.com/getsentry/sentry/>`_ (Translate Sentry!)

+ 2 - 1
setup.py

@@ -93,7 +93,8 @@ setup(
     author_email="hello@sentry.io",
     url="https://sentry.io",
     description="A realtime logging and aggregation server.",
-    long_description=open(os.path.join(ROOT, "README.rst")).read(),
+    long_description=open(os.path.join(ROOT, "README.md")).read(),
+    long_description_content_type="text/markdown",
     package_dir={"": "src"},
     packages=find_packages("src"),
     zip_safe=False,