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 users of Springwolf to README.md #476

Merged
merged 1 commit into from
Nov 24, 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
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,17 @@ Contributing follows mostly the following steps:

1. For bigger changes, open an [issue](https://github.com/springwolf/springwolf-core/issues) and/or drop by on our discord so that we can coordinate.
2. Fork the repository
- Create a new branch
3. Apply your changes
- Add/Adapt tests as necessary
4. Run the tests
- Run tests locally via `./gradlew test`
- Run tests locally via `./gradlew test` (includes `unitTest` and `integrationTest` targets, which executes faster)
5. Run the code formatter
- We use the palantir code style and disallow wildcard imports
- Run `./gradlew spotlessApply` to fix most things automatically
6. Commit your changes & push
7. Open a Pull-Request against the springwolf repository
- Use the provided template to briefly describe why the changes should be included
8. Update the [documentation](https://github.com/springwolf/springwolf.github.io) as necessary
9. Add yourself to the contributors and your company to the users in [README.md](README.md)

21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

**Automated documentation for event-driven applications built with Spring Boot**

![Last Version](https://img.shields.io/github/tag-pre/springwolf/springwolf-core.svg)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![springwolf-core](https://github.com/springwolf/springwolf-core/actions/workflows/springwolf-core.yml/badge.svg)](https://github.com/springwolf/springwolf-core/actions/workflows/springwolf-core.yml)
[![springwolf-ui](https://github.com/springwolf/springwolf-core/actions/workflows/springwolf-ui.yml/badge.svg)](https://github.com/springwolf/springwolf-core/actions/workflows/springwolf-ui.yml)
Expand All @@ -16,6 +17,7 @@
- [Demo & Documentation](#demo--documentation)
- [Why You Should Use It](#why-you-should-use-it)
- [Usage & Example](#usage--example)
- [Who's Using Springwolf](#whos-using-springwolf)
- [Development](#development)
- [Contributors](#contributors)

Expand All @@ -37,12 +39,12 @@ The documentation and quickstart is available on [springwolf.dev](https://www.sp
Springwolf exploits the fact that you already fully described your consumer endpoint (with listener annotations, such as
`@KafkaListener`, `@RabbitListener`, `@SqsListener`, etc.) and generates the documentation based on this information.

#### Share API Schema Definition
#### 1. Share API Schema Definition

The AsyncAPI conform documentation can be integrated into API hubs (like [backstage](https://backstage.io/docs/features/software-catalog/descriptor-format/))
or be shared as a `json`/`yaml` file with others.

#### UI Based API Testing
#### 2. UI Based API Testing
In projects using asynchronous APIs, you may often find yourself needing to manually send a message to some topic,
whether you are manually testing a new feature, debugging or trying to understand some flow.

Expand All @@ -65,8 +67,22 @@ More details in the documentation.
| [Generic Binding](https://github.com/springwolf/springwolf-core/tree/master/springwolf-add-ons/springwolf-generic-binding) | | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-generic-binding?color=green&label=springwolf-generic-binding&style=plastic) | ![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/io.github.springwolf/springwolf-generic-binding?label=springwolf-generic-binding&server=https%3A%2F%2Fs01.oss.sonatype.org&style=plastic) |
| [Json Schema](https://github.com/springwolf/springwolf-core/tree/master/springwolf-add-ons/springwolf-json-schema) | | ![Maven Central](https://img.shields.io/maven-central/v/io.github.springwolf/springwolf-json-schema?color=green&label=springwolf-json-schema&style=plastic) | ![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/io.github.springwolf/springwolf-json-schema?label=springwolf-json-schema&server=https%3A%2F%2Fs01.oss.sonatype.org&style=plastic) |

### Who's Using Springwolf

- [b.well Connected Health](https://www.icanbwell.com/)
- [LVM Versicherung](https://www.lvm.de/privatkunden/)
- [OTTO](https://www.otto.de)
- [Teambank](https://www.teambank.de)

Comment in [this PR](https://github.com/springwolf/springwolf-core/issues/342) to add your company and spread the word

### Development

Check out our [CONTRIBUTING.md](CONTRIBUTING.md) guide.

<details>
<summary>Using SNAPSHOT version</summary>

#### Sonatype snapshots

Add the following to the `repositories` closure in `build.gradle`:
Expand Down Expand Up @@ -99,6 +115,7 @@ Or add the `repository` to your `pom.xml` if you are using maven:
#### Local Snapshot Build

To work with local builds, run the `publishToMavenLocal` task. The current version number is set in [`.env`](.env) file.
</details>

### Contributors

Expand Down