Skip to content

Commit

Permalink
Create draft-integration.md (#183)
Browse files Browse the repository at this point in the history
* Create draft-integration.md

I'm creating this draft integration file that can be re-used which should hopefully help us make these pages more uniform.

* Update draft-integration.md

Co-authored-by: Tilde Thurium <[email protected]>

* Update draft-integration.md

Co-authored-by: Bilge Yücel <[email protected]>

* Update draft-integration.md

Co-authored-by: Bilge Yücel <[email protected]>

* Update draft-integration.md

Co-authored-by: Bilge Yücel <[email protected]>

* Update draft-integration.md

---------

Co-authored-by: Tilde Thurium <[email protected]>
Co-authored-by: Bilge Yücel <[email protected]>
  • Loading branch information
3 people authored Feb 19, 2024
1 parent 032d7ac commit 298a52f
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions draft-integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
layout: integration
name: Name of your integration
description: Description of integration
authors:
- name: author-name
socials:
github: author-username
twitter: author-username
linkedin: author-linkedin-url
pypi: https://pypi.org/project/{project-slug}
repo: https://your-repo-url
type: Type of integration (e.g.: Model Provider or Document Sotre)
report_issue: https://your-repo-url/issues
logo: /logos/your-logo.png
version: Haystack 2.0
toc: true
---
### **Table of Contents**
- [Overview](#overview)
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)

## Overview
Add more information about this integration such as its features, links to its documentation

## Installation

```bash
pip install your-package
```

## Usage
### Components
This integration introduces X components:

- The `ComponentName`:

### Use XYZ

```python
Example code block (must actually run, include all imports, etc.)
```

### License

Info about your integration license

0 comments on commit 298a52f

Please sign in to comment.