Skip to content

Commit 4017b09

Browse files
authored
docs: Improve Readme (#28)
1 parent ea6f036 commit 4017b09

File tree

3 files changed

+36
-7
lines changed

3 files changed

+36
-7
lines changed

README.md

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,45 @@
33
[![Pipeline](https://github.com/xC0dex/APIWeaver/actions/workflows/ci.yml/badge.svg)](https://github.com/xC0dex/APIWeaver/actions/workflows/ci.yml)
44
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=xC0dex_APIWeaver&metric=coverage)](https://sonarcloud.io/summary/new_code?id=xC0dex_APIWeaver)
55
[![NuGet Version](https://img.shields.io/nuget/v/APIWeaver.Swagger)](https://www.nuget.org/packages/APIWeaver.Swagger/)
6-
[![NuGet Version](https://img.shields.io/nuget/dt/APIWeaver.OpenApi)](https://www.nuget.org/packages/APIWeaver.Swagger/)
6+
[![NuGet Downloads](https://img.shields.io/nuget/dt/APIWeaver.OpenApi)](https://www.nuget.org/packages/APIWeaver.Swagger/)
77

88

9-
APIWeaver is a powerful, lightweight, and feature-rich library designed to provide comprehensive OpenAPI support in .NET
10-
6 and newer.
9+
APIWeaver is a powerful and lightweight library designed to provide a seamless integration of OpenAPI and Swagger UI into your .NET 6+ apps. APIWeaver supports the latest .NET 8 features and is designed to be future-proof, ensuring support for upcoming .NET and OpenAPI features.
1110

12-
APIWeaver is committed to long-term development, ensuring support for upcoming .NET and OpenAPI features.
1311

1412
## Work in progress
1513

16-
This project is currently in the **active development** phase, with ongoing improvements, new features and potential API
17-
changes. Contributions of any kind are highly appreciated!
14+
This project is currently under **active development**, with ongoing improvements, new features and potential API
15+
changes. I encourage you to try it out and provide feedback, but please be aware that the library is not yet stable.
16+
17+
## Getting Started
18+
19+
To get started with APIWeaver, you can install the NuGet package using your preferred package manager. In most cases, the package `APIWeaver.Swagger` is the one you are looking for.
20+
21+
1. Install the NuGet package
22+
```shell
23+
dotnet add package APIWeaver.Swagger
24+
```
25+
26+
2. Add the using directive to your Program.cs file
27+
```csharp
28+
using APIWeaver;
29+
```
30+
31+
3. Add the following lines to your `Program.cs` file.
32+
```csharp
33+
builder.Services.AddApiWeaver();
34+
35+
// other code
36+
37+
if (app.Environment.IsDevelopment())
38+
{
39+
app.UseSwaggerUi();
40+
}
41+
```
42+
43+
That's it. You now have a fully functional Swagger UI in your application. The UI can be accessed by navigating to /swagger in your browser 🥳. A more detailed guide with more use cases can be found here.
44+
1845

1946
## Contribution and Collaboration
2047

@@ -23,5 +50,5 @@ success!
2350

2451
## License
2552

26-
Distributed under the MIT License. See LICENSE for more information.
53+
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.
2754
This means APIWeaver will always remain free.

docs/Getting-Started.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Coming soon

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Coming soon

0 commit comments

Comments
 (0)