From f26cbbb27212f7e97cdffd8a2180fbc1729e2416 Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Thu, 24 Sep 2020 17:09:52 -0700 Subject: [PATCH 1/6] Update README.md --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 95cddde9..17bb5987 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Typesense is a fast, typo-tolerant search engine for building delightful search - [Search UIs](#search-uis) - [Build from Source](#build-from-source) - [FAQ](#faq) -- [Help](#help) +- [Support](#support) ## Features @@ -192,8 +192,20 @@ Hacker News titles are indexed along with their points, Typesense consumes 165 M on disk in JSON format is 88 MB. We hope to add better benchmarks on a variety of different data sets soon. In the mean time, if you have any numbers from your own datasets, please send us a PR! -## Help +## Support + +If you have any questions or run into any problems, please create a Github issue and we'll try our best to help. + +We strive to provide good support through our issue trackers on Github. + +However, if you'd like to receive private & prioritized support with: + +- Guaranteed SLAs +- Phone / video calls to discuss your specific use case and suggest best practices +- Private discussions over Slack +- Guidance around deployment, ops and scaling best practices + +We do offer Paid Support options. Please reach out to us at contact@typesense.org to sign up. -If you've any questions or run into any problems, please create a Github issue and we'll try our best to help. © 2016-2020 Typesense Inc. From dffc52e7548c1fa91470ce522a67365715e66910 Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Thu, 24 Sep 2020 20:28:50 -0700 Subject: [PATCH 2/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 17bb5987..d94d1bc0 100644 --- a/README.md +++ b/README.md @@ -201,7 +201,7 @@ We strive to provide good support through our issue trackers on Github. However, if you'd like to receive private & prioritized support with: - Guaranteed SLAs -- Phone / video calls to discuss your specific use case and suggest best practices +- Phone / video calls to discuss your specific use case and get recommendations on best practices - Private discussions over Slack - Guidance around deployment, ops and scaling best practices From 16632137202bb5b9d5cf0972d94953b2be2b89b0 Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Fri, 25 Sep 2020 15:46:04 -0700 Subject: [PATCH 3/6] Update README.md --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d94d1bc0..e756d0ec 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,12 @@ Typesense is a fast, typo-tolerant search engine for building delightful search - [Features](#features) - [Install](#install) - [Quick Start](#quick-start) -- [Detailed Guide](#detailed-guide) +- [Step-by-step Walk-through](#step-by-step-walk-through) - [Search UIs](#search-uis) - [Build from Source](#build-from-source) - [FAQ](#faq) - [Support](#support) +- [Getting Latest Updates](#getting-latest-updates) ## Features @@ -103,9 +104,9 @@ client.collections['companies'].documents.search(search_parameters) **Did you notice the typo in the query text?** No big deal. Typesense handles typographic errors out-of-the-box! -## Detailed Guide +## Step-by-step Walk-through -A detailed guide is available on [Typesense website](https://typesense.org/guide). +A step-by-step walk-through is available on our [website](https://typesense.org/guide). ## Search UIs @@ -196,9 +197,7 @@ In the mean time, if you have any numbers from your own datasets, please send us If you have any questions or run into any problems, please create a Github issue and we'll try our best to help. -We strive to provide good support through our issue trackers on Github. - -However, if you'd like to receive private & prioritized support with: +We strive to provide good support through our issue trackers on Github. However, if you'd like to receive private & prioritized support with: - Guaranteed SLAs - Phone / video calls to discuss your specific use case and get recommendations on best practices @@ -207,5 +206,12 @@ However, if you'd like to receive private & prioritized support with: We do offer Paid Support options. Please reach out to us at contact@typesense.org to sign up. +## Getting Latest Updates +If you'd like to get updates when we release new versions, click on the "Watch" button on the top and select "Releases only". Github will then send you notifications along with a changelog with each new release. + +We also post updates to our Twitter account about releases and additional topics related to Typesense. Follow us here: [@typesense](https://twitter.com/typesense). + + +--- © 2016-2020 Typesense Inc. From 4fb5009625bd88d1cca606f1654d1ce205787c6b Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Fri, 25 Sep 2020 15:53:09 -0700 Subject: [PATCH 4/6] Update README.md --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e756d0ec..6fd60847 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ Typesense is a fast, typo-tolerant search engine for building delightful search - [Install](#install) - [Quick Start](#quick-start) - [Step-by-step Walk-through](#step-by-step-walk-through) +- [API Documentation](#api-documentation) - [Search UIs](#search-uis) - [Build from Source](#build-from-source) - [FAQ](#faq) @@ -106,7 +107,15 @@ client.collections['companies'].documents.search(search_parameters) ## Step-by-step Walk-through -A step-by-step walk-through is available on our [website](https://typesense.org/guide). +A step-by-step walk-through is available on our website [here](https://typesense.org/guide). + +This will guide you through the process of starting up a Typesense server, indexing data in it and querying the data set. + +## API Documentation + +Here's our official API documentation, available on our website: [https://typesense.org/api](https://typesense.org/api). + +If you notice any issues with the documentation or walk-through, please let us know or send us a PR here: [https://github.com/typesense/typesense-website](https://github.com/typesense/typesense-website). ## Search UIs @@ -146,7 +155,7 @@ The first build will take some time since other third-party libraries are pulled ## FAQ -**How does this differ from using Elasticsearch?** +**How does this differ from Elasticsearch?** Elasticsearch is better suited for large teams who have the bandwidth to administer, scale and fine-tune it and especially when they have a need to store billions of documents and scale horizontally. @@ -155,7 +164,7 @@ Typesense is built specifically for decreasing the "time to market" for a deligh focusing on Developer Productivity and Experience with a clean API, clear semantics and smart defaults so that it just works without turning many knobs. -**How does this differ from using Algolia?** +**How does this differ from Algolia?** Algolia is a proprietary, hosted, search-as-a-service product that works well, when cost is not an issue. From our experience, fast growing sites and apps quickly run into search & indexing limits, accompanied by expensive plan upgrades as they scale. From ff680be070b8700a3a72ce244d0e21ffcc019b6c Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Mon, 28 Sep 2020 15:44:59 -0700 Subject: [PATCH 5/6] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 6fd60847..092902bb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ Typesense [![CircleCI](https://circleci.com/gh/typesense/typesense.svg?style=shield&circle-token=1addd775339738a3d90869ddd8201110d561feaa)](https://circleci.com/gh/typesense/typesense) +![Docker Pulls](https://img.shields.io/docker/pulls/typesense/typesense) Typesense is a fast, typo-tolerant search engine for building delightful search experiences. From 198117d46ddfe43c9f382c7d32093704e24bb2a8 Mon Sep 17 00:00:00 2001 From: Jason Bosco Date: Mon, 28 Sep 2020 15:56:23 -0700 Subject: [PATCH 6/6] Use SVG for logo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 092902bb..6e7a1c80 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Typesense +Typesense [![CircleCI](https://circleci.com/gh/typesense/typesense.svg?style=shield&circle-token=1addd775339738a3d90869ddd8201110d561feaa)](https://circleci.com/gh/typesense/typesense) ![Docker Pulls](https://img.shields.io/docker/pulls/typesense/typesense)