Skip to content

Commit f4f75c1

Browse files
committed
Add README.md for ViewsCount module
1 parent 389e2ec commit f4f75c1

2 files changed

Lines changed: 44 additions & 0 deletions

File tree

src/OrchardCoreContrib.ViewCount/OrchardCoreContrib.ViewCount.csproj

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
<Authors>The Orchard Core Contrib Team</Authors>
77
<Company />
88
<Description>Allows to count the content item views.</Description>
9+
<PackageReadmeFile>README.md</PackageReadmeFile>
910
<PackageLicenseExpression>BSD-3-Clause</PackageLicenseExpression>
1011
<PackageProjectUrl>https://github.com/OrchardCoreContrib/OrchardCoreContrib.Modules/tree/main/src/OrchardCoreContrib.ViewCount/README.md</PackageProjectUrl>
1112
<RepositoryUrl>https://github.com/OrchardCoreContrib/OrchardCoreContrib.Modules</RepositoryUrl>
@@ -26,6 +27,7 @@
2627

2728
<ItemGroup>
2829
<None Include="../../images/icon.png" Pack="true" PackagePath="icon.png" />
30+
<None Include="README.md" Pack="true" PackagePath="\"/>
2931
</ItemGroup>
3032

3133
<ItemGroup>
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# View Count Module
2+
3+
This module provides settings and services to send SMS messages using Azure Communication Service.
4+
5+
## Version
6+
7+
1.0.0
8+
9+
## Category
10+
11+
Content Management
12+
13+
## Dependencies
14+
15+
| Product | Module |
16+
|-------------|-----------------------------------|
17+
| OrchardCore | Contents (`OrchardCore.Contents`) |
18+
19+
## Features
20+
21+
| | |
22+
|------------------|--------------------------------------------|
23+
| **Name** | View Count (`OrchardCoreContrib.ViewCount`)|
24+
| **Description** | Allow you to send SMS via ACS SMS service. |
25+
| **Dependencies** | `OrchardCore.Contents` |
26+
27+
## NuGet Packages
28+
29+
| Name | Version |
30+
|---------------------------------------------------------------------------------------------------------|---------|
31+
| [`OrchardCoreContrib.ViewCount`](https://www.nuget.org/packages/OrchardCoreContrib.ViewCount/1.0.0) | 1.0.0 |
32+
33+
## Get Started
34+
35+
1. Install the [`OrchardCoreContrib.ViewCount`](https://www.nuget.org/packages/OrchardCoreContrib.ViewCount/) NuGet package to your Orchard Core host project.
36+
2. Go to the admin site
37+
3. Select **Configuration -> Features** menu.
38+
4. Enable the `View Count` feature.
39+
5. Go to the **Contents -> Content Definitions -> Content Types**
40+
6. Edit the content type that you want to track its number of views.
41+
7. Click the `Add Part` button.
42+
8. Choose `View Count` from the list.

0 commit comments

Comments
 (0)