From e1d6e01759724d667f3cf117a0b9425e01290f1e Mon Sep 17 00:00:00 2001 From: Tai Groot Date: Tue, 22 Jul 2025 03:18:43 -0700 Subject: [PATCH] Add GitHub sponsor config, 0BSD license, and update README style MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add .github/FUNDING.yml with GitHub sponsor configuration - Add LICENSE file with 0BSD license text - Update README.md to match taigrr repository style with badges and improved formatting - Change license from MIT to 0BSD to match other taigrr projects 💖 Generated with Crush Co-Authored-By: Crush --- .github/FUNDING.yml | 12 ++++++++++++ LICENSE | 5 +++++ README.md | 32 ++++++++++++++++++-------------- 3 files changed, 35 insertions(+), 14 deletions(-) create mode 100644 .github/FUNDING.yml create mode 100644 LICENSE diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..5a7c84c --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,12 @@ +# These are supported funding model platforms + +github: taigrr # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] +patreon: # Replace with a single Patreon username +open_collective: # Replace with a single Open Collective username +ko_fi: # Replace with a single Ko-fi username +tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel +community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry +liberapay: # Replace with a single Liberapay username +issuehunt: # Replace with a single IssueHunt username +otechie: # Replace with a single Otechie username +custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..3871a8c --- /dev/null +++ b/LICENSE @@ -0,0 +1,5 @@ +Copyright (C) 2025 by Tai Groot + +Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index ccd627d..a49ad0a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ -# Gotify MCP Server +# gotify-mcp -A Model Context Protocol (MCP) server that enables LLMs to send notifications to a Gotify server. This allows AI assistants to notify users about task completion, request help, or provide activity summaries. +[![License 0BSD](https://img.shields.io/badge/License-0BSD-pink.svg)](https://opensource.org/licenses/0BSD) +[![GoDoc](https://godoc.org/github.com/taigrr/gotify-mcp?status.svg)](https://godoc.org/github.com/taigrr/gotify-mcp) +[![Go Mod](https://img.shields.io/badge/go.mod-v1.23-blue)](go.mod) + +A Model Context Protocol (MCP) server that enables LLMs to send notifications to a Gotify server. +This allows AI assistants to notify users about task completion, request help, or provide activity summaries. ## Features @@ -18,23 +23,18 @@ The MCP server requires the following environment variables: ## Installation -1. Clone the repository: +```bash +go install github.com/taigrr/gotify-mcp@latest +``` + +Or build from source: + ```bash git clone https://github.com/taigrr/gotify-mcp.git cd gotify-mcp -``` - -2. Build the binary: -```bash go build -o gotify-mcp ``` -3. Set up environment variables: -```bash -export GOTIFY_URL="https://your-gotify-server.com" -export GOTIFY_TOKEN="your-application-token" -``` - ## Usage The MCP server communicates over stdio and provides the following tools: @@ -90,4 +90,8 @@ Example configuration for Claude Desktop: ## License -This project is licensed under the MIT License. \ No newline at end of file +This project is licensed under the 0BSD License, written by [Rob Landley](https://github.com/landley). +As such, you may use this library without restriction or attribution, but please don't pass it off as your own. +Attribution, though not required, is appreciated. + +By contributing, you agree all code submitted also falls under the License. \ No newline at end of file