Skip to content

Commit

Permalink
add readme, fix contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
EPMatt committed May 9, 2024
1 parent d1f9515 commit 73387d3
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 4 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ This document describes our development process. Following these guidelines show

Before reading further, please note that:

> [!NOTE]
> This repository depends on Google's Firebase Genkit. For issues and questions related to GenKit, please refer to instructions available in [GenKit's repository](https://github.com/firebase/genkit).
## Table of Contents
Expand Down
49 changes: 47 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,48 @@
# OpenAI Community Plugin for Genkit
<h1 align="center">
Firebase Genkit <> OpenAI Plugin
</h1>

License: Apache 2.0
<h4 align="center">OpenAI Community Plugin for Google Firebase Genkit</h4>

<div align="center">

</div>
</br>

**`@firecompany/genkitx-openai`** is a community plugin for using OpenAI APIs with
[Firebase GenKit](https://github.com/firebase/genkit).


## Installation

Install the plugin in your project with your favorite package manager:

* `npm install @firecompany/genkitx-openai`
* `yarn add @firecompany/genkitx-openai`

## Usage
> [!WARNING]
> Documentation is currently work in progress.
## Contributing

Want to contribute to the project? That's awesome! Head over to our [Contribution Guidelines](CONTRIBUTING.md).

## Need support?

> [!NOTE]
> This repository depends on Google's Firebase Genkit. For issues and questions related to GenKit, please refer to instructions available in [GenKit's repository](https://github.com/firebase/genkit).
Reach out by opening a discussion on [Github Discussions](https://github.com/TheFireCo/genkitx-openai/discussions).

## Credits

This plugin is proudly maintained by the team at [**The Fire Company**](https://github.com/TheFireCo). 🔥

## License

This project is licensed under the [Apache 2.0 License](LICENSE.md).

[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202%2E0-lightgrey.svg)](LICENSE.md)
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 73387d3

Please sign in to comment.