Skip to content

Commit 45a60d1

Browse files
committed
Added separate nuget readme
1 parent 32a856a commit 45a60d1

File tree

3 files changed

+42
-1
lines changed

3 files changed

+42
-1
lines changed

AutoCtor.slnx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<Solution>
22
<Folder Name="/Solution Items/">
33
<File Path="mdsnippets.json" />
4+
<File Path="readme.nuget.source.md" />
45
<File Path="readme.source.md" />
56
<File Path="src/Common.props" />
67
<File Path="src/Directory.Build.props" />

readme.nuget.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# AutoCtor
2+
3+
AutoCtor is a Roslyn Source Generator that will automatically create a constructor for your class for use with constructor Dependency Injection.
4+
5+
# How to Use
6+
7+
- Make the class `partial`
8+
- Add `[AutoConstruct]`
9+
- Remove the constructor
10+
11+
```diff
12+
-public class AService
13+
+[AutoConstruct]
14+
+public partial class AService
15+
{
16+
private readonly IDataContext _dataContext;
17+
private readonly IDataService _dataService;
18+
private readonly IExternalService _externalService;
19+
private readonly ICacheService _cacheService;
20+
private readonly ICacheProvider _cacheProvider;
21+
private readonly IUserService _userService;
22+
23+
- public AService(
24+
- IDataContext dataContext,
25+
- IDataService dataService,
26+
- IExternalService externalService,
27+
- ICacheService cacheService,
28+
- ICacheProvider cacheProvider,
29+
- IUserService userService
30+
- )
31+
- {
32+
- _dataContext = dataContext;
33+
- _dataService = dataService;
34+
- _externalService = externalService;
35+
- _cacheService = cacheService;
36+
- _cacheProvider = cacheProvider;
37+
- _userService = userService;
38+
- }
39+
}
40+
```

src/AutoCtor.Attributes/AutoCtor.Attributes.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<Authors>Cameron MacFarland</Authors>
1515
<Description>Source Generator to automatically create a constructor with all the readonly fields set.</Description>
1616
<PackageLicenseExpression>MIT</PackageLicenseExpression>
17-
<PackageReadmeFile>readme.md</PackageReadmeFile>
17+
<PackageReadmeFile>readme.nuget.md</PackageReadmeFile>
1818
<PackageOutputPath>$(ProjectDir)..\..\nugets</PackageOutputPath>
1919
<PackageProjectUrl>https://github.com/distantcam/AutoCtor</PackageProjectUrl>
2020
</PropertyGroup>

0 commit comments

Comments
 (0)