Update READMEs (deepset-ai#17)

jdixosnd · Mar 15, 2023 · 58c751c · 58c751c
1 parent ad73fd6
commit 58c751c
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -1,19 +1,23 @@
-# haystack-extras
+# Haystack Extras
 
-> NOTICE: this is my Hacky Friday project, do not rely on anything in this repo at this moment!
+This repository contains extra components for [Haystack][haystack-repo], see the component `README.md` for detailed installation and usage instructions.
 
-You will need `hatch` to create new projects in this folder. Run `pip install -r requirements.txt` to install it.
+This is the list of packages currently part of the repo.
+
+| Package | Type | PyPi Package | Status |
+| ----------------------------------------------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
+| [text2speech](./nodes/text2speech/) | Node | [![PyPI - Version](https://img.shields.io/pypi/v/farm-haystack-text2speech.svg)](https://pypi.org/project/farm-haystack-text2speech) | [![Test / text2speech][text2speechbadge]][text2speech] |
+| [speech2text](./nodes/speech2text/) | Node | [![PyPI - Version](https://img.shields.io/pypi/v/farm-haystack-speech2text.svg)](https://pypi.org/project/farm-haystack-speech2text) | [![Test / speech2text][speech2textbadge]][speech2text] |
+| [mongodb-documentstore](stores/mongodb-documentstore) | Document Store | [![PyPI - Version](https://img.shields.io/pypi/v/farm-haystack-mongodb-documentstore.svg)](https://pypi.org/project/farm-haystack-mongodb-documentstore) | [![Test / MongoDBDocumentStore][mongodbdocumentstorebadge]][mongodbdocumentstore] |
 
-| Package | Type | Status |
-| ----------------------------------------------------- | -------------- | --------------------------------------------------------------------------------- |
-| [text2speech](./nodes/text2speech/) | Node | [![Test / text2speech][text2speechBadge]][text2speech] |
-| [speech2text](./nodes/speech2text/) | Node | [![Test / speech2text][speech2textBadge]][speech2text] |
-| [mongodb-documentstore](stores/mongodb-documentstore) | Document Store | [![Test / MongoDBDocumentStore][MongoDBDocumentStoreBadge]][MongoDBDocumentStore] |
+## Contributing
 
+You will need `hatch` to create new projects in this folder. Run `pip install -r requirements.txt` to install it.
 
-[text2speechBadge]: https://github.com/deepset-ai/haystack-extras/actions/workflows/nodes_text2speech.yml/badge.svg
+[haystack-repo]: https://github.com/deepset-ai/haystack
+[text2speechbadge]: https://github.com/deepset-ai/haystack-extras/actions/workflows/nodes_text2speech.yml/badge.svg
 [text2speech]: https://github.com/deepset-ai/haystack-extras/actions/workflows/nodes_text2speech.yml
-[speech2textBadge]: https://github.com/deepset-ai/haystack-extras/actions/workflows/nodes_speech2text.yml/badge.svg
+[speech2textbadge]: https://github.com/deepset-ai/haystack-extras/actions/workflows/nodes_speech2text.yml/badge.svg
 [speech2text]: https://github.com/deepset-ai/haystack-extras/actions/workflows/nodes_speech2text.yml
-[MongoDBDocumentStoreBadge]: https://github.com/deepset-ai/haystack-extras/actions/workflows/stores_mongodb_document_store.yml/badge.svg
-[MongoDBDocumentStore]: https://github.com/deepset-ai/haystack-extras/actions/workflows/stores_mongodb_document_store.yml
+[mongodbdocumentstorebadge]: https://github.com/deepset-ai/haystack-extras/actions/workflows/stores_mongodb_document_store.yml/badge.svg
+[mongodbdocumentstore]: https://github.com/deepset-ai/haystack-extras/actions/workflows/stores_mongodb_document_store.yml
diff --git a/nodes/speech2text/README.md b/nodes/speech2text/README.md
@@ -14,7 +14,7 @@
 ## Installation
 
 ```console
-pip install farm-haystack-text2speech-speech2text
+pip install farm-haystack-speech2text
 ```
 
 ## Installation
@@ -28,7 +28,7 @@ sudo apt-get install libsndfile1 ffmpeg
 Step 2. Install the package. With pip:
 
 ```console
-pip install farm-haystack-text2speech-speech2text
+pip install farm-haystack-speech2text
 ```
 
 ## License

diff --git a/nodes/text2speech/README.md b/nodes/text2speech/README.md
@@ -14,7 +14,7 @@
 ## Installation
 
 ```console
-pip install farm-haystack-text2speech-text2speech
+pip install farm-haystack-text2speech
 ```
 
 ## Installation
@@ -28,7 +28,7 @@ sudo apt-get install libsndfile1 ffmpeg
 Step 2. Install the package. With pip:
 
 ```console
-pip install farm-haystack-text2speech-text2speech
+pip install farm-haystack-text2speech
 ```
 
 ## License

diff --git a/stores/mongodb-documentstore/README.md b/stores/mongodb-documentstore/README.md
@@ -1,9 +1,9 @@
 # haystack_mongodb_documentstore
 
-[![PyPI - Version](https://img.shields.io/pypi/v/haystack-mongodb-documentstore.svg)](https://pypi.org/project/mongodb-documentstore)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mongodb-documentstore.svg)](https://pypi.org/project/mongodb-documentstore)
+[![PyPI - Version](https://img.shields.io/pypi/v/farm-haystack-mongodb-documentstore.svg)](https://pypi.org/project/farm-haystack-mongodb-documentstore)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/farm-haystack-mongodb-documentstore.svg)](https://pypi.org/project/farm-haystack-mongodb-documentstore)
 
------
+---
 
 **Table of Contents**
 
@@ -15,7 +15,7 @@
 ## Installation
 
 ```console
-pip install haystack-mongodb-documentstore
+pip install farm-haystack-mongodb-documentstore
 ```
 
 ## Usage
@@ -38,4 +38,4 @@ print_answers(prediction, details="minimum")
 
 ## License
 
-`haystack-mongodb-documentstore` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.
+`mongodb-documentstore` is distributed under the terms of the [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) license.