Skip to content

Commit

Permalink
chore: cleanup readme with sponsors and readability (#1039)
Browse files Browse the repository at this point in the history
  • Loading branch information
derberg authored Feb 29, 2024
1 parent aed791e commit 220637d
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 111 deletions.
149 changes: 38 additions & 111 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,15 @@
[![AsyncAPI Logo](./assets/logo.png)](https://www.asyncapi.com)

<hr/>

<!--
<p align="center">
<a href="https://iqvia.com" target="_blank">
<img src="./assets/iqvia.png" alt="IQVIA logo" height="40">
</a>
&nbsp;&nbsp;&nbsp;&nbsp;
<a href="https://mulesoft.com" target="_blank">
<img src="./assets/mulesoft.png" alt="Mulesoft logo" height="40">
</a>
&nbsp;&nbsp;&nbsp;&nbsp;
<a href="https://salesforce.com" target="_blank">
<img src="./assets/salesforce.png" alt="Salesforce logo" height="40">
</a>
&nbsp;&nbsp;&nbsp;&nbsp;
<a href="https://sap.com" target="_blank">
<img src="./assets/sap.svg" alt="SAP logo" height="40">
</a>
&nbsp;
<a href="https://slack.com" target="_blank">
<img src="./assets/slack.svg" alt="Slack logo" height="40">
</a>
&nbsp;
<a href="https://solace.com" target="_blank">
<img src="./assets/solace.png" alt="Solace logo" height="40">
</a>
&nbsp;
<a href="https://tibco.com" target="_blank">
<img src="./assets/tibco.png" alt="TIBCO logo" height="40">
</a>
</p>
<p align="center">
:raised_hands: Platinum sponsors. <a href="https://opencollective.com/asyncapi">Join them!</a> :raised_hands:
</p>
-->

## Read the specification

The latest draft specification can be found at [spec/asyncapi.md](./spec/asyncapi.md) which tracks the latest commit to the master branch in this repository.
The human-readable markdown file is the source of truth for the specification.

- [Version 3.0.0](https://github.com/asyncapi/spec/blob/v3.0.0/spec/asyncapi.md) (latest)
**The human-readable markdown file is the source of truth for the specification.**

- [Version 3.0.0](https://github.com/asyncapi/spec/blob/v3.0.0/spec/asyncapi.md) (latest) ([website](https://www.asyncapi.com/docs/reference/specification/latest))
<details>
<summary>Click to see reference links to older versions of the specification.</summary>

- [Version 2.6.0](https://github.com/asyncapi/spec/blob/v2.6.0/spec/asyncapi.md)
- [Version 2.5.0](https://github.com/asyncapi/spec/blob/v2.5.0/spec/asyncapi.md)
- [Version 2.4.0](https://github.com/asyncapi/spec/blob/v2.4.0/spec/asyncapi.md)
Expand All @@ -54,100 +20,61 @@ The human-readable markdown file is the source of truth for the specification.
- [Version 1.2.0](https://github.com/asyncapi/spec/blob/1.2.0/README.md) (deprecated)
- [Version 1.1.0](https://github.com/asyncapi/spec/blob/1.1.0/README.md) (deprecated)
- [Version 1.0.0](https://github.com/asyncapi/spec/blob/1.0.0/README.md) (deprecated)
</details>

**Looking for the JSON Schema files?** Check out our [spec-json-schemas](https://github.com/asyncapi/spec-json-schemas) repo.

**Feel like contributing?** Check out our [community repo](https://www.github.com/asyncapi/community).

## Examples

#### :bulb: Streetlights

Demonstrates how to use AsyncAPI to define an API that controls city streetlights.

> :point_right: [See more](./examples/streetlights-mqtt.yml)
#### <img src="./assets/slack.png" width="15" alt="Slack icon">&nbsp;&nbsp; Slack Events API

Partial definition of the Slack Events API. Find the official one [here](https://github.com/slackapi/slack-api-specs/blob/master/events-api/slack_events_api_async_v1.json).

> :point_right: [See more](./examples/slack-rtm.yml)
#### <img src="./assets/gitter.png" width="15" alt="Gitter icon">&nbsp;&nbsp; Gitter Streaming API

Definition of the Gitter streaming API.
</br>

> :point_right: [See more](./examples/gitter-streaming.yml)
Looking for the JSON Schema files? Check out our [spec-json-schemas](https://github.com/asyncapi/spec-json-schemas) repo.

#### <img src="./assets/gemini.svg" width="15" alt="Gemini icon">&nbsp;&nbsp; Gemini WebSocket API
Feel like contributing? Check out our [contributor's guide](./CONTRIBUTING.md).

Definition of the Gemini Websocket API.
## Examples

> :point_right: [See more](./examples/websocket-gemini.yml)
Check out the [examples](https://github.com/asyncapi/asyncapi/blob/master/examples) directory for examples.

#### :heavy_plus_sign: and more...
## Case Studies and Adopters

Check out the [examples](https://github.com/asyncapi/asyncapi/blob/master/examples) directory for more examples.
Check out the [AsyncAPI website](https://www.asyncapi.com/casestudies) to see the list of AsyncAPI adopters and their use cases.

## Our Sponsors

Want to become a sponsor? Learn [what we do with sponsors` money](https://www.asyncapi.com/finance) and [join the club](https://opencollective.com/asyncapi).

### Platinum

<p align="center">

<a href="https://solace.com" target="_blank">
<img src="./assets/solace.png" alt="Solace logo" height="70">
</a>
&nbsp;&nbsp;&nbsp;&nbsp;
<a href="https://ibm.com" target="_blank">
<img src="./assets/ibm.png" alt="IBM logo" height="70">
</a>
&nbsp;&nbsp;&nbsp;&nbsp;
<a href="https://postman.com" target="_blank">
<img src="./assets/postman.png" alt="Postman logo" height="90">
</a>
</p>

<img src="./assets/ibm.png" alt="IBM logo" height="70">
</a>
&nbsp;&nbsp;&nbsp;&nbsp;
<a href="https://solace.com" target="_blank">
<img src="./assets/solace.png" alt="Solace logo" height="70">
</a>

### Gold

<p align="center">

<a href="https://redhat.com" target="_blank">
<img src="./assets/redhat.png" alt="RedHat logo" height="70">
</a>
&nbsp;&nbsp;&nbsp;&nbsp;

</p>
<a href="https://postman.com" target="_blank">
<img src="./assets/postman.png" alt="Postman logo" height="90">
</a>

### Silver

<p align="center">

<a href="https://bump.sh/asyncapi?utm_source=asyncapi&utm_medium=github_readme&utm_campaign=sponsor" target="_blank">
<img src="./assets/bump-sh-white-bg.png" alt="Bump.sh logo" height="70">
</a>
&nbsp;&nbsp;&nbsp;&nbsp;
<a href="https://www.svix.com/" target="_blank">
<img src="./assets/swix.png" alt="swix logo" height="70">
</a>
&nbsp;&nbsp;&nbsp;&nbsp;

</p>
<img src="./assets/bump-sh-white-bg.png" alt="Bump.sh logo" height="70">
</a>
&nbsp;&nbsp;&nbsp;&nbsp;
<a href="https://www.svix.com/" target="_blank">
<img src="./assets/svix.png" alt="svix logo" height="70">
</a>
&nbsp;&nbsp;&nbsp;&nbsp;
<a href="https://www.hivemq.com/" target="_blank">
<img src="./assets/hivemq.png" alt="hivemq logo" height="70">
</a>

### Bronze

<p align="center">

<a href="https://ably.com/" target="_blank">
<img src="./assets/ably.png" alt="ably.png logo" height="70">
</a>
&nbsp;&nbsp;&nbsp;&nbsp;
<a href="https://rviewer.io/" target="_blank">
<img src="./assets/rviewer.png" alt="rviewer.png logo" height="70">
</a>
&nbsp;&nbsp;&nbsp;&nbsp;
</p>
<a href="https://redhat.com" target="_blank">
<img src="./assets/redhat.png" alt="RedHat logo" height="70">
</a>

## Contributors

Expand Down
Binary file removed assets/ably.png
Binary file not shown.
Binary file added assets/hivemq.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/svix.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/swix.png
Binary file not shown.

0 comments on commit 220637d

Please sign in to comment.