adds basic details to readme

shivuslr41 · Dec 24, 2022 · ef1bf1f · ef1bf1f
1 parent 0defad0
commit ef1bf1f
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,9 @@
 # grpc-tester
+
+`grpc-tester` is a simple command-line tool cum library for testing gRPC services.
+
+This tool leverage [grpcurl](https://github.com/fullstorydev/grpcurl) to create dynamic requests and [jq](https://github.com/stedolan/jq) for comparing/validating responses.
+
+NOTE: currently doesn't work on windows cmd/powershell.
+
+DOCUMENTATION is work in progress, have a look at `examples/` to get overview of tool usage!