Update readme (#1)

README.md

@@ -1,2 +1,130 @@
-# fdb-go-layer-plugin
-Protoc plugin to generate go code for foundationdb 
+# FoundationDB Go Layer Plugin
+
+A `protoc` plugin that generates Go repository code for interacting with FoundationDB, based on annotated Protobuf definitions.
+
+## Overview
+
+The FoundationDB Go Layer Plugin simplifies the process of creating Go repositories that interact with FoundationDB. By annotating your Protobuf messages with custom options, you can automatically generate repository code that handles common CRUD operations, including support for primary keys and secondary indexes.
+
+## Features
+
+-   Automatic Repository Generation: Generate Go code for repositories based on your Protobuf message definitions.
+-   Primary Key Support: Define primary keys using custom annotations in your .proto files.
+-   Secondary Indexes: Add secondary indexes to your messages for efficient querying.
+-   FoundationDB Integration: Generated code uses the FoundationDB Go bindings for database operations.
+-   Transaction Management: Supports both automatic and manual transaction management.
+-   Customizable and Extensible: Extend and customize the generated code without modifying the generated files.
+
+## Installation
+
+### Prerequisites
+-   Go 1.18 or later
+-   `protoc` compiler (version compatible with your Protobuf definitions)
+-   FoundationDB installed and configured
+-   `protoc-gen-go` and `protoc-gen-go-grpc` plugins installed
+
+### Install the Plugin
+You can install the plugin using go install:
+```
+go install github.com/romannikov/fdb-go-layer-plugin@latest
+```
+Ensure that your GOPATH/bin is in your PATH so that protoc can find the plugin:
+```
+export PATH="$PATH:$(go env GOPATH)/bin"
+```
+
+## Usage
+
+### Define Your Protobuf Messages
+Create your `.proto` files with custom annotations for primary keys and secondary indexes.
+
+Example `user.proto`:
+```
+syntax = "proto3";
+
+package myapp;
+
+option go_package = "github.com/yourusername/yourproject/pb;pb";
+
+import "fdb-go-layer/annotations.proto";
+
+message User {
+  option (annotations.primary_key) = "id";
+  option (annotations.secondary_index) = { fields: "email" };
+
+  int64 id = 1;
+  string name = 2;
+  string email = 3;
+}
+```
+### Generate Code
+Run the `protoc` compiler with the plugin to generate Go code for your messages and repositories.
+```
+protoc \
+  --plugin=protoc-gen-fdb-go-layer-plugin=./fdb-go-layer-plugin \
+  --fdb-go-layer-plugin_out=. \
+  --go_out=. \
+  --go_opt=paths=source_relative \
+  user.proto
+```
+### Use the Generated Repositories
+Import the generated repository code into your Go application.
+```
+package main
+
+import (
+    "context"
+    "fmt"
+    "log"
+
+    "github.com/apple/foundationdb/bindings/go/src/fdb"
+    pb "github.com/yourusername/yourproject/pb"
+    "github.com/yourusername/yourproject/repositories"
+)
+
+func main() {
+    fdb.MustAPIVersion(620)
+    db := fdb.MustOpenDefault()
+
+    userRepo, err := repositories.NewUserRepository(db)
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    ctx := context.Background()
+
+    // Create a new user
+    user := &pb.User{
+        Id:    1,
+        Name:  "Alice",
+        Email: "alice@example.com",
+    }
+
+    // Save the user using a transaction
+    err = db.Transact(func(tr fdb.Transaction) (interface{}, error) {
+        return nil, userRepo.Set(ctx, tr, user)
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    fmt.Println("User saved successfully")
+}
+```
+# Contributing
+Contributions are welcome! Please open issues and pull requests to improve the plugin.
+
+## Fork the repository.
+- Create a new branch: `git checkout -b feature/your-feature`.
+- Commit your changes: `git commit -am 'Add new feature'`.
+- Push to the branch: `git push origin feature/your-feature`.
+- Open a pull request.
+
+# License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+# Acknowledgments
+- [FoundationDB](https://www.foundationdb.org) for their powerful distributed database.
+- [Protocol Buffers](https://protobuf.dev) for efficient data serialization.
+- The [Go](https://go.dev) community for their valuable libraries and tools.