diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..0e552c4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Environment (please complete the following information):** + - OS: [e.g. Windows] + - .NET version [e.g. .NET 5.0] + - Version [e.g. 1.0.3] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index c2801b2..9d94ca2 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -1,6 +1,10 @@ name: Publish NuGet package on: push: + paths-ignore: + - '.github/**' + - 'README.md' + - 'LICENSE' branches: - master jobs: diff --git a/README.md b/README.md index d001f02..ba64558 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,12 @@ # Kutt.NET -An API wrapper for [Kutt](kutt.it), written in C#. +An API wrapper for [Kutt.it](https://kutt.it), written in C#. [![GitHub](https://img.shields.io/github/downloads/AlphaNecron/Kutt.NET/total?color=%237BA1F7&logo=github&style=for-the-badge)](https://github.com/AlphaNecron/Kutt.NET/releases/latest) [![NuGet](https://img.shields.io/nuget/dt/Kutt.NET?color=%237BA1F7&logo=nuget&style=for-the-badge)](https://www.nuget.org/packages/Kutt.NET) [![Latest](https://img.shields.io/github/v/tag/AlphaNecron/Kutt.NET?color=%237BA1F7&label=RELEASE&logo=github&sort=semver&style=for-the-badge)](https://github.com/AlphaNecron/Kutt.NET/releases/latest) +[![Workflow status](https://img.shields.io/github/workflow/status/AlphaNecron/Kutt.NET/Publish%20NuGet%20package?color=7BA1F7&logo=github&style=for-the-badge)](https://github.com/AlphaNecron/Kutt.NET) [![MIT](https://img.shields.io/github/license/AlphaNecron/Kutt.NET?color=%237BA1F7&style=for-the-badge)](#) ## Authors @@ -21,6 +22,9 @@ An API wrapper for [Kutt](kutt.it), written in C#. // Initializes a Kutt instance with default server KuttApi kutt = new KuttApi("your_api_key"); +// Initializes a Kutt instance with your own server +KuttApi kutt = new KuttApi("your_api_key", "https://example.com"); + // Creates a shortened URL Link link = await CreateLinkAsync("https://github.com"); Console.WriteLine($"Shortened URL: {link.ShortUrl}");