diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9efd71d5..f83cc064 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/README.md b/README.md index 39c1e35e..cef5fe77 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,48 @@ -# OpenAI Community Plugin for Genkit +

+ Firebase Genkit <> OpenAI Plugin +

-License: Apache 2.0 \ No newline at end of file +

OpenAI Community Plugin for Google Firebase Genkit

+ +
+ +
+ +
+ +**`@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) \ No newline at end of file