From 8f1accab5409189e64a3e542e30b5f4ef3b96353 Mon Sep 17 00:00:00 2001 From: Kevin Franklin Kim Date: Tue, 11 Mar 2025 16:03:49 +0100 Subject: [PATCH] docs: add README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index e69de29..b4d6832 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,16 @@ +# Typesense +[![Build Status](https://github.com/foomo/typesense/actions/workflows/test.yml/badge.svg?branch=main&event=push)](https://github.com/foomo/typesense/actions/workflows/test.yml) +[![Go Report Card](https://goreportcard.com/badge/github.com/foomo/typesense)](https://goreportcard.com/report/github.com/foomo/typesense) +[![GoDoc](https://godoc.org/github.com/foomo/typesense?status.svg)](https://godoc.org/github.com/foomo/typesense) + +> Typesense Search integration with Content Server + +## How to Contribute + +Please refer to the [CONTRIBUTING](.github/CONTRIBUTING.md) details and follow the [CODE_OF_CONDUCT](.github/CODE_OF_CONDUCT.md) and [SECURITY](.github/SECURITY.md) guidelines. + +## License + +Distributed under MIT License, please see license file within the code for more details. + +_Made with ♥ [foomo](https://www.foomo.org) by [bestbytes](https://www.bestbytes.com)_