diff --git a/README.md b/README.md index 2e28d4f..4cc1d48 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,96 @@ -
-
-
-
- Matro is a graphql code generator inspired by swagger -
- -
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+ Matro is a GraphQL code generator inspired by Swagger. +
+ + + +--- + +## Overview -## Getting started +Matro is a tool designed to generate GraphQL schemas and related backend components, inspired by the simplicity and efficiency of Swagger. It aims to streamline backend development by automating repetitive tasks. -### 1. Pre-requisites - 1. Go version 17.x+ - 2. For grpc - 1. google.golang.org/grpc v1.44.0 - 2. google.golang.org/protobuf v1.27.1 - 3. Gnu Make +--- + +## Getting Started + +### 1. Prerequisites + +* Go 1.17+ +* gRPC dependencies: + + * `google.golang.org/grpc v1.44.0` + * `google.golang.org/protobuf v1.27.1` +* GNU Make -### 2. How to Install -```sh - $. git clone git@github.com:firstcontributions/matro.git - $. cd matro - $. make config - $. make build +--- + +### 2. Installation + +```bash id="s1d9e2" +git clone https://github.com/firstcontributions/matro.git +cd matro +make config +make build ``` -## Progress --- -- [x] GraphQL Schema generator -- [x] gRPC proto buf & service stub generator -- [x] gRPC service implementation -- [x] Models/ Store generator -- [x] Graphql golang implementation -- [ ] React-relay generator + +## Features / Progress + +* [x] GraphQL schema generator +* [x] gRPC protobuf and service stub generator +* [x] gRPC service implementation +* [x] Models / store generator +* [x] GraphQL Golang implementation +* [ ] React Relay generator + +--- + +## Project Structure + +```text id="y7f8k1" +cmd/ → CLI entry points +pkg/ → Core logic +internal/ → Internal modules +``` + +--- + +## Contributing + +Contributions are welcome! + +1. Fork the repository +2. Create a new branch +3. Make your changes +4. Submit a pull request + +--- + +## License + +This project is licensed under the MIT License. + + +