diff --git a/README.md b/README.md index 766be7662..31432e519 100644 --- a/README.md +++ b/README.md @@ -24,38 +24,37 @@ Minimalistic API linter of awesomeness, bringing order to a sea of APIs. - Zally Web UI is another client build on top of React and Node.js - Rule changes only have to be applied in the server component -**Tech Stack:** Zally server is written in Java 8 with Spring Boot. We made rule implementation -optional possible in Kotlin. API-specific code remains in Java 8 due to better integration with -Spring Boot. Further details can be found [here](https://github.com/zalando-incubator/zally/pull/65#issuecomment-269474831). -With Spring 5 we consider using Kotlin also on API side directly. Stay tuned. - +**Tech Stack:** Zally server is written in Java 8 with Spring Boot. +We made rule implementation optional possible in Kotlin. +API-specific code remains in Java 8 due to better integration with Spring Boot. +Further details can be found [here](https://github.com/zalando-incubator/zally/pull/65#issuecomment-269474831). +With Spring 5 we consider using Kotlin also on API side directly. +Zally CLI is implemented in Golang. ### Dependencies -- Java 8 (server) +- Java 8 (Server) - Golang 1.7+ (CLI) -- Node.js 7.6+ (web-ui) +- Node.js 7.6+ (Web-UI) ### Installation and Usage -You can find installation steps in the [Server Readme](server/README.md), [CLI Readme](cli/README.md) and [Web UI Readme](https://github.com/zalando-incubator/zally-web-ui/blob/master/README.md). +You can find installation steps in the [Server Readme](server/README.md), [CLI Readme](cli/README.md) and [Web UI Readme](web-ui/README.md). If you just wanna try it out: first run the server locally, then just use the CLI tool as it is provided. ### Roadmap -For [version 1.1](https://github.com/zalando-incubator/zally/milestone/1) we focus on these three main areas: - -- improve rule implementations -- improve CLI user experience -- improve web UI -- use better integration testing approaches +For [version 1.2](https://github.com/zalando-incubator/zally/milestone/3) we focus on these main areas: -Feel free to contribute on related issues for version 1.1. +- Consistency with [Zalando RESTful API Guidelines](http://zalando.github.io/restful-api-guidelines/) +- Referential integrity with [Zalando RESTful API Guidelines](http://zalando.github.io/restful-api-guidelines/) +- New rules +- New quick start script and better integration testing approaches -Afterwards we focus on Github integration and more sophisticated features. +Feel free to contribute on related issues for version 1.2. ### Quick start guide @@ -65,7 +64,6 @@ cd zally # Disable authentication and start a local version of Zally server cd server -echo "spring.profiles.active=dev" >> application.properties ./gradlew clean build ./gradlew bootRun > /dev/null & cd ..