Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add logo #153

Merged
merged 3 commits into from
Apr 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 19 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# <img src="logo.png" alt="Logo" width="100"/> Springwolf Core
##### Automated documentation for AsyncAPIs built with Spring Boot

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
![springwolf-core](https://github.com/stavshamir/springwolf/workflows/springwolf-core/badge.svg)
![springwolf-kafka](https://github.com/stavshamir/springwolf/workflows/springwolf-kafka/badge.svg)
![springwolf-amqp](https://github.com/stavshamir/springwolf/workflows/springwolf-amqp/badge.svg)
![springwolf-cloud-stream](https://github.com/stavshamir/springwolf/workflows/springwolf-cloud-stream/badge.svg)

# Springwolf Core
##### Automated documentation for async APIs built with Spring Boot

*NEW: A discord server has been opened for any question, discussion, request etc. - you are welcome to join https://discord.gg/HZYqd5RPTd*
> We are on discord for any question, discussion, request etc.
> Join us at https://discord.gg/HZYqd5RPTd

### Table Of Contents
- [About](#about)
- [Demo](#demo)
- [Documentation](#documentation)
- [Supported protocols](#supported-protocols)
- [Why you should use it](#why-you-should-use-it)
- [Usage](#usage)
- [Example Projects](#example-projects)
- [Usage & Example](#usage--example)
- [Development](#development)

### About
Expand Down Expand Up @@ -47,23 +47,25 @@ Springwolf exploits the fact you already fully described your consumer endpoint
`@KafkaListner`, `@RabbitListener` etc.) and automatically generates an example payload object for the appropriate payload and allows you
to publish it to the correct channel with a single click.

### Usage
See:
- [Kafka](https://github.com/springwolf/springwolf-core/tree/master/springwolf-plugins/springwolf-kafka-plugin)
- [AMQP](https://github.com/springwolf/springwolf-core/tree/master/springwolf-plugins/springwolf-amqp-plugin)

### Usage & Example

### Example Projects
- [Kafka](https://github.com/springwolf/springwolf-core/tree/master/springwolf-examples/springwolf-kafka-example)
- [AMQP](https://github.com/springwolf/springwolf-core/tree/master/springwolf-examples/springwolf-amqp-example)
| Code / Plugin | Example project | Current version | SNAPSHOT version |
|-----------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Core](https://github.com/springwolf/springwolf-core/tree/master/springwolf-core) | | | |
| [AMQP](https://github.com/springwolf/springwolf-core/tree/master/springwolf-plugins/springwolf-amqp-plugin) | [AMQP Example](https://github.com/springwolf/springwolf-core/tree/master/springwolf-examples/springwolf-amqp-example) | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-amqp?color=green&label=springwolf-amqp&style=plastic) | ![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/io.github.springwolf/springwolf-amqp?label=springwolf-amqp&server=https%3A%2F%2Fs01.oss.sonatype.org&style=plastic) |
| [Cloud Stream](https://github.com/springwolf/springwolf-core/tree/master/springwolf-plugins/springwolf-cloud-stream-plugin) | [Cloud Stream Example](https://github.com/springwolf/springwolf-core/tree/master/springwolf-examples/springwolf-cloud-stream-example) | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-cloud-stream?color=green&label=springwolf-cloud-stream&style=plastic) | ![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/io.github.springwolf/springwolf-cloud-stream?label=springwolf-cloud-stream&server=https%3A%2F%2Fs01.oss.sonatype.org&style=plastic) |
| [Kafka](https://github.com/springwolf/springwolf-core/tree/master/springwolf-plugins/springwolf-kafka-plugin) | [Kafka Example](https://github.com/springwolf/springwolf-core/tree/master/springwolf-examples/springwolf-kafka-example) | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-kafka?color=green&label=springwolf-kafka&style=plastic) | ![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/io.github.springwolf/springwolf-kafka?label=springwolf-kafka&server=https%3A%2F%2Fs01.oss.sonatype.org&style=plastic) |


### Development
#### Sonatype snapshots
Add the following to the `repositories` closure:
Add the following to the `repositories` closure in `build.gradle`:
```groovy
maven {
url "https://s01.oss.sonatype.org/content/repositories/snapshots"
repositories {
// ...
maven {
url "https://s01.oss.sonatype.org/content/repositories/snapshots"
}
}
```

Expand Down
Binary file added logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.