Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace all text references of Github to GitHub #16

Merged
merged 1 commit into from
Sep 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
_Before you submit a pull request, please make sure you have read and understood the [contribution guidelines](https://github.com/xavidop/genkitx-github/blob/main/CONTRIBUTING.md) and the [code of conduct](https://github.com/xavidop/genkitx-github/blob/main/CODE_OF_CONDUCT.md)._
_Before you submit a pull request, please make sure you have read and understood the [contribution guidelines](https://github.com/xavidop/genkitx-GitHub/blob/main/CONTRIBUTING.md) and the [code of conduct](https://github.com/xavidop/genkitx-GitHub/blob/main/CODE_OF_CONDUCT.md)._

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this URL does not need to be changed

**This pull request is related to:**

Expand All @@ -9,12 +9,12 @@ _Before you submit a pull request, please make sure you have read and understood

**I have checked the following:**

- [ ] I have read and understood the [contribution guidelines](https://github.com/xavidop/genkitx-github/blob/main/CONTRIBUTING.md) and the [code of conduct](https://github.com/xavidop/genkitx-github/blob/main/CODE_OF_CONDUCT.md);
- [ ] I have read and understood the [contribution guidelines](https://github.com/xavidop/genkitx-GitHub/blob/main/CONTRIBUTING.md) and the [code of conduct](https://github.com/xavidop/genkitx-GitHub/blob/main/CODE_OF_CONDUCT.md);
- [ ] I have added new tests (for bug fixes/features);
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this URL does not need to be changed

- [ ] I have added/updated the documentation (for bug fixes / features).

**Description:**
Please provide a clear and concise description of the changes you are proposing here.

**Related issues:**
Please, link the related issues that this pull request will resolve here (if any).
Please, link the related issues that this pull request will resolve here (if any).
2 changes: 1 addition & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ updates:
- "npm"
- "dependencies"
schedule:
interval: daily
interval: daily
2 changes: 1 addition & 1 deletion CONTRIBUITING.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,4 @@ Or with the `npm: build` VSCode task. More about VSCode tasks [here](https://cod

## About this document

These contribution guidelines are adapted by the [Embedded Artistry Templates](https://github.com/embeddedartistry/templates). Licensing information about the original information of this document can be found [here](https://github.com/embeddedartistry/templates/blob/master/LICENSE).
These contribution guidelines are adapted by the [Embedded Artistry Templates](https://github.com/embeddedartistry/templates). Licensing information about the original information of this document can be found [here](https://github.com/embeddedartistry/templates/blob/master/LICENSE).
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
![Firebase Genkit + Github Models](https://github.com/xavidop/genkitx-github/blob/main/assets/genkit-github.png?raw=true)
![Firebase Genkit + GitHub Models](https://github.com/xavidop/genkitx-github/blob/main/assets/genkit-github.png?raw=true)

<h1 align="center">
Firebase Genkit <> Github Models Plugin
Firebase Genkit <> GitHub Models Plugin
</h1>

<h4 align="center">Github Models Community Plugin for Google Firebase Genkit</h4>
<h4 align="center">GitHub Models Community Plugin for Google Firebase Genkit</h4>

<div align="center">
<img alt="Github version" src="https://img.shields.io/github/v/release/xavidop/genkitx-github">
<img alt="GitHub version" src="https://img.shields.io/github/v/release/xavidop/genkitx-github">
<img alt="NPM Downloads" src="https://img.shields.io/npm/dw/genkitx-github">
<img alt="GitHub License" src="https://img.shields.io/github/license/xavidop/genkitx-github">
<img alt="Static Badge" src="https://img.shields.io/badge/yes-a?label=maintained">
Expand All @@ -21,10 +21,10 @@

</br>

**`genkitx-github`** is a community plugin for using Github Models APIs with
**`genkitx-github`** is a community plugin for using GitHub Models APIs with
[Firebase Genkit](https://github.com/firebase/genkit). Built by [**Xavier Portilla Edo**](https://github.com/xavidop).

This Genkit plugin allows to use Github models through their official APIs.
This Genkit plugin allows to use GitHub models through their official APIs.

## Installation

Expand All @@ -38,7 +38,7 @@ Install the plugin in your project with your favorite package manager:

### Configuration

To use the plugin, you need to configure it with your Github Token key. You can do this by calling the `configureGenkit` function:
To use the plugin, you need to configure it with your GitHub Token key. You can do this by calling the `configureGenkit` function:

```typescript
import {github, openAIGpt4o} from "genkitx-github";
Expand Down Expand Up @@ -139,7 +139,7 @@ For more detailed examples and the explanation of other functionalities, refer t

## Supported models

This plugin supports all currently available **Chat/Completion** and **Embeddings** models from Github Models. This plugin supports image input and multimodal models.
This plugin supports all currently available **Chat/Completion** and **Embeddings** models from GitHub Models. This plugin supports image input and multimodal models.

Still in progress:
1. Support for image output models
Expand All @@ -157,7 +157,7 @@ Want to contribute to the project? That's awesome! Head over to our [Contributio
> [!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/xavidop/genkitx-github/discussions).
Reach out by opening a discussion on [GitHub Discussions](https://github.com/xavidop/genkitx-github/discussions).

## Credits

Expand All @@ -169,4 +169,4 @@ I got the inspiration, structure and patterns to create this plugin from the [Ge

This project is licensed under the [Apache 2.0 License](https://github.com/xavidop/genkitx-github/blob/main/LICENSE).

[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202%2E0-lightgrey.svg)](https://github.com/xavidop/genkitx-github/blob/main/LICENSE)
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202%2E0-lightgrey.svg)](https://github.com/xavidop/genkitx-github/blob/main/LICENSE)
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Only the last stable version at any given point.

## Reporting a Vulnerability

Vulnerabilities can be disclosed via email to xavierportillaedo@gmail.com
Vulnerabilities can be disclosed via email to xavierportillaedo@gmail.com
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "genkitx-github",
"description": "Firebase Genkit AI framework plugin for Github Models APIs.",
"description": "Firebase Genkit AI framework plugin for GitHub Models APIs.",
"keywords": [
"genkit",
"genkit-plugin",
Expand Down
Loading