Skip to content

Commit 11caf2f

Browse files
authored
Update README.md
1 parent 3d42740 commit 11caf2f

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

README.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,22 @@
11
# UK.NHS.CookieBanner
22

3+
# Cookie Banner NuGet Package for .NET Core
4+
This NuGet package provides an easy-to-use cookie banner for .NET Core web applications. The cookie banner allows you to comply with the EU Law and the GDPR by informing users about the use of cookies on your website and giving them the option to accept or decline cookies.
5+
6+
It is designed to work with API calls, SQL server, and custom classes.
7+
8+
# Installation
9+
You can install the package via NuGet Package Manager or by running the following command in the Package Manager Console:
10+
11+
```bash
12+
Install-Package UK.NHS.CookieBanner
13+
````
14+
15+
## Usage
16+
317
### Update _Layout.cshtml file
418

5-
Add following configuration in _Layout.cshtml
19+
In your _Layout.cshtml file (or any other view where you want to display the cookie banner), add the following code
620
Need to add in Header section nhsuk.css if it doesnt exist
721

822
```bash
@@ -17,19 +31,15 @@ Need to add in Header section nhsuk.css if it doesnt exist
1731
@RenderSection("NavBreadcrumbs", false)
1832
```
1933

20-
### Update _Layout.cshtml file
21-
22-
Add following configuration in _Layout.cshtml
23-
Need to add in Header section nhsuk.css if it doesnt exist
24-
2534
```bash
2635
<link rel="stylesheet" href="~/_content/UK.NHS.CookieBanner/lib/cookiebanner/css/nhsuk.css" asp-append-version="true" />
2736
```
2837

2938
### Update Program.cs file
30-
3139
Program.cs
3240

41+
There is a possibility of utilising various sources to populate the cookie policy content through different means, including calling APIs, using a SQL server, or implementing a custom approach.
42+
3343
#### SQL based source
3444
```bash
3545
builder.Services.AddScoped<ICookiePolicyService, CookiePolicyDBService>();
@@ -60,3 +70,10 @@ or
6070
"ClientIdentityKey": ""
6171
}
6272
```
73+
74+
## Contributions
75+
Contributions are welcome! Please feel free to submit issues and pull requests.
76+
77+
## License
78+
This project is licensed under the MIT License. See the LICENSE file for details.
79+

0 commit comments

Comments
 (0)