Skip to content

Commit

Permalink
feat: prepare readme for the next release (zalando#854)
Browse files Browse the repository at this point in the history
  • Loading branch information
maxim-tschumak committed Sep 26, 2018
1 parent daf238c commit 2898425
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 13 deletions.
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,25 @@

### Zally: A minimalistic, simple-to-use API linter

Zally brings order to your sea of APIs. Use it to:
- enable/disable rules on the server side
- configure (some) of the existing rules
- implement your own rules in [Kotlin](https://kotlinlang.org/)
... for OpenAPI 3 and Swagger 2 API specifications.

Its standard configuration will check your APIs against the rules defined in [Zalando's RESTful Guidelines](http://zalando.github.io/restful-api-guidelines/), but anyone can use it **out-of-the-box**.

Zally's easy-to-use [CLI](cli/README.md) uses the server in the background so that you can check your API *on the spot*. It also features an intuitive [Web UI](web-ui/README.md) that shows implemented rules and lints external files and (with its online editor) API definitions.

More about Zally:
- OpenAPI-friendly: accepts [OpenAPI (fka Swagger) Specifications](https://github.com/OAI/OpenAPI-Specification) .yaml and JSON formats; includes a server that lints your OpenAPI files; and parses OpenAPI files using [swagger-parser](https://github.com/swagger-api/swagger-parser)
- OpenAPI-friendly: accepts [OpenAPI 3 and Swagger Specifications](https://github.com/OAI/OpenAPI-Specification) .yaml and JSON formats; includes a server that lints your OpenAPI files; and parses OpenAPI files using [swagger-parser](https://github.com/swagger-api/swagger-parser)
- Using `x-zally-ignore` extension in your API definition, you can disable rules for a specific API
- Applying rule changes is only necessary in the server component
- API-specific code written in Java 8 with [Spring Boot](https://github.com/spring-projects/spring-boot) for better integration
- Rule implementation is optimal/possible in Kotlin
- Rule implementation is optimal/possible in [Kotlin](https://kotlinlang.org/)

### Technical Dependencies

- Kotlin and Java 8 (server) with Spring Boot
- Golang 1.7+: for CLI
- Node.js 7.6+: for web UI

Find additional details [here](https://github.com/zalando/zally/pull/65#issuecomment-269474831). With Spring 5, we consider using Kotlin also directly on the API side.

### Installation and Usage

To give Zally a quick try, first run the server locally and then use the CLI tool.
Expand Down Expand Up @@ -62,10 +57,13 @@ More details about how to register[Webhooks](https://developer.github.com/webhoo
Zally welcomes contributions from the open source community. To get started, take a look at our [contributing guidelines](CONTRIBUTING). Then check our [Project Board](https://github.com/zalando/zally/projects/1) and [Issues Tracker](https://github.com/zalando/zally/issues) for ideas.

#### Roadmap
For Zally [version 1.2](https://github.com/zalando/zally/milestone/3), we're focusing on:
- generating new rules
- a new quickstart script
- better integration testing approaches
For Zally [version 1.5](https://github.com/zalando/zally/milestone/3), we're focusing on:
- Making Zally easier to extend and adjust to custom guidelines and rules
- Better integration testing approaches
- Making further rules compatible with OpenAPI 3
- Providing more utilities for check developers
- Improving check execution process
- Provide high-quality documentation for check developers, operators and users

If you have ideas for these items, please let us know.

Expand Down
2 changes: 1 addition & 1 deletion cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ zally rules

```bash
cd cli/zally
goreleaser --skip-publish v1.1.0
goreleaser release --skip-publish
```

1. Check builds inside `cli/zally/dist` directory.
Expand Down

0 comments on commit 2898425

Please sign in to comment.