redmine-api - npm Package Compare versions

Comparing version 4.11.0 to 4.14.0

README.md

@@ -0,64 +1,101 @@
+# ![Redmine .NET API](https://raw.githubusercontent.com/zapadi/redmine-net-api/master/logo.png) redmine-net-api
 
-![Redmine .NET Api](https://github.com/zapadi/redmine-net-api/workflows/CI%2FCD/badge.svg?branch=master)
-![Appveyor last build status](https://ci.appveyor.com/api/projects/status/github/zapadi/redmine-net-api?branch=master&svg=true&passingText=master%20-%20OK&failingText=ups...)
-[![NuGet package](https://img.shields.io/nuget/v/redmine-api.svg)](https://www.nuget.org/packages/redmine-api)
-![Nuget](https://img.shields.io/nuget/dt/redmine-api)
-<a href="https://www.buymeacoffee.com/vXCNnz9" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/lato-yellow.png" alt="Buy Me A Coffee" height="37" ></a>
+[![NuGet](https://img.shields.io/nuget/v/redmine-api.svg)](https://www.nuget.org/packages/redmine-api) 
+[![NuGet Downloads](https://img.shields.io/nuget/dt/redmine-api)](https://www.nuget.org/packages/redmine-api) 
+[![License](https://img.shields.io/github/license/zapadi/redmine-net-api)](LICENSE)
+[![Contributors](https://img.shields.io/github/contributors/zapadi/redmine-net-api)](https://github.com/zapadi/redmine-net-api/graphs/contributors)
 
 
-# redmine-net-api   ![redmine-net-api logo](https://github.com/zapadi/redmine-net-api/blob/master/logo.png) 
+A modern and flexible .NET client library to interact with [Redmine](https://www.redmine.org)'s REST API.
 
-redmine-net-api is a library for communicating with a Redmine project management application.
 
-* Uses [Redmine's REST API.](http://www.redmine.org/projects/redmine/wiki/Rest_api/)
-* Supports both XML and **JSON** formats.
-* Supports GZipped responses from servers.
-* This API provides access and basic CRUD operations (create, read, update, delete) for the resources described below:
+## 🚀 Features
 
-| Resource            |  Read   | Create  | Update  | Delete  |
-|:--------------------|:-------:|:-------:|:-------:|:-------:|
-| Attachments         | &check; | &check; | &cross; | &cross; |
-| Custom Fields       | &check; | &cross; | &cross; | &cross; |
-| Enumerations        | &check; | &cross; | &cross; | &cross; |
-| Files               | &check; | &check; | &cross; | &cross; |
-| Groups              | &check; | &check; | &check; | &check; |
-| Issues              | &check; | &check; | &check; | &check; |
-| Issue Categories    | &check; | &check; | &check; | &check; |
-| Issue Relations     | &check; | &check; | &check; | &check; |
-| Issue Statuses      | &check; | &cross; | &cross; | &cross; |
-| My account          | &check; | &cross; | &check; | &cross; |
-| News                | &check; | &check; | &check; | &check; |
-| Projects            | &check; | &check; | &check; | &check; |
-| Project Memberships | &check; | &check; | &check; | &check; |
-| Queries             | &check; | &cross; | &cross; | &cross; |
-| Roles               | &check; | &cross; | &cross; | &cross; |
-| Search              | &check; |         |         |         |
-| Time Entries        | &check; | &check; | &check; | &check; |
-| Trackers            | &check; | &cross; | &cross; | &cross; |
-| Users               | &check; | &check; | &check; | &check; |
-| Versions            | &check; | &check; | &check; | &check; |
-| Wiki Pages          | &check; | &check; | &check; | &check; |
+- Full REST API support with CRUD operations
+- Supports both XML and JSON data formats
+- Handles GZipped server responses transparently
+- Easy integration via NuGet package
+- Actively maintained and community-driven
 
-## WIKI
+| Resource             | Read | Create | Update | Delete |
+|----------------------|:----:|:------:|:------:|:------:|
+| Attachments          | ✅   | ✅     | ❌     | ❌     |
+| Custom Fields        | ✅   | ❌     | ❌     | ❌     |
+| Enumerations         | ✅   | ❌     | ❌     | ❌     |
+| Files                | ✅   | ✅     | ❌     | ❌     |
+| Groups               | ✅   | ✅     | ✅     | ✅     |
+| Issues               | ✅   | ✅     | ✅     | ✅     |
+| Issue Categories     | ✅   | ✅     | ✅     | ✅     |
+| Issue Relations      | ✅   | ✅     | ✅     | ✅     |
+| Issue Statuses       | ✅   | ❌     | ❌     | ❌     |
+| My Account           | ✅   | ❌     | ✅     | ❌     |
+| News                 | ✅   | ✅     | ✅     | ✅     |
+| Projects             | ✅   | ✅     | ✅     | ✅     |
+| Project Memberships  | ✅   | ✅     | ✅     | ✅     |
+| Queries              | ✅   | ❌     | ❌     | ❌     |
+| Roles                | ✅   | ❌     | ❌     | ❌     |
+| Search               | ✅   |        |        |        |
+| Time Entries         | ✅   | ✅     | ✅     | ✅     |
+| Trackers             | ✅   | ❌     | ❌     | ❌     |
+| Users                | ✅   | ✅     | ✅     | ✅     |
+| Versions             | ✅   | ✅     | ✅     | ✅     |
+| Wiki Pages           | ✅   | ✅     | ✅     | ✅     |
 
-Please review the ![wiki](https://github.com/zapadi/redmine-net-api/wiki) pages on how to use **redmine-net-api**.
 
-## Contributing
-Contributions are really appreciated!
+## 📦 Installation
 
-A good way to get started (flow):
+Add the package via NuGet:
 
-1. Fork the redmine-net-api repository.
-2. Create a new branch in your current repos from the 'master' branch.
-3. 'Check out' the code with *Git*, *GitHub Desktop*, *SourceTree*, *GitKraken*, *etc*.
-4. Push commits and create a Pull Request (PR) to redmine-net-api.
+```bash
+dotnet add package Redmine.Net.Api
+```
 
-## License
-[![redmine-net-api](https://img.shields.io/hexpm/l/plug.svg)]()
+Or via Package Manager Console:
 
-The API is released under Apache 2 open-source license. You can use it for both personal and commercial purposes, build upon it and modify it.
+```powershell
+Install-Package Redmine.Net.Api
+```
 
-## Contributors
-Thanks to all the people who already contributed!
 
+## 🧑‍💻 Usage Example
+
+```csharp
+using Redmine.Net.Api;
+using Redmine.Net.Api.Types;
+using System;
+using System.Threading.Tasks;
+
+class Program
+{
+    static async Task Main()
+    {
+        var options = new RedmineManagerOptionsBuilder()
+            .WithHost("https://your-redmine-url")
+            .WithApiKeyAuthentication("your-api-key");
+
+        var manager = new RedmineManager(options);
+
+        // Retrieve an issue asynchronously
+        var issue = await manager.GetAsync<Issue>(12345);
+        Console.WriteLine($"Issue subject: {issue.Subject}");
+    }
+}
+```
+Explore more usage examples on the [Wiki](https://github.com/zapadi/redmine-net-api/wiki).
+
+
+## 📚 Documentation
+
+Detailed API reference, guides, and tutorials are available in the [GitHub Wiki](https://github.com/zapadi/redmine-net-api/wiki).
+
+
+## 🙌 Contributing
+
+See the [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
+
+
+## 🤝 Contributors
+
+Thanks to all contributors!
+
 <a href="https://github.com/zapadi/redmine-net-api/graphs/contributors">
@@ -68,8 +105,11 @@ <img src="https://contrib.rocks/image?repo=zapadi/redmine-net-api" />
 
-## Thanks
 
-I would like to thank:
+## 📝 License
 
-* JetBrains for my Open Source ReSharper licence, 
+This project is licensed under the [Apache License 2.0](LICENSE).
 
-* AppVeyor for allowing free build CI services for Open Source projects
+
+## ☕ Support
+
+If you find this project useful, consider ![[buying me a coffee](https://cdn.buymeacoffee.com/buttons/lato-yellow.png)](https://www.buymeacoffee.com/vXCNnz9) to support development.
+

redmine-api.nuspec

@@ -5,3 +5,3 @@ <?xml version="1.0" encoding="utf-8"?>
     <id>redmine-api</id>
-    <version>4.11.0</version>
+    <version>4.14.0</version>
     <title>Redmine .NET API Client</title>
@@ -19,3 +19,3 @@ <authors>Adrian Popescu</authors>
     <tags>Redmine REST API Client .NET Adrian Popescu</tags>
-    <repository type="git" url="https://github.com/zapadi/redmine-net-api" commit="d5027106487d8fd327c30c0ccbf2e3fe3495a01a" />
+    <repository type="git" url="https://github.com/zapadi/redmine-net-api" commit="fc89105853dc798395058d9828ec369e3ef9398e" />
     <dependencies>
@@ -22,0 +22,0 @@ <group targetFramework=".NETFramework2.0">

No alert changes

No metric changes