Skip to content

Commit 3e234d2

Browse files
update README.md with solution support
1 parent f1b7545 commit 3e234d2

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# dotnet-subset
2+
[![NuGet version (dotnet-subset)](https://img.shields.io/nuget/v/dotnet-subset.svg?style=flat-square)](https://www.nuget.org/packages/dotnet-subset/)
3+
[![GitHub workflow](https://github.com/nimbleways/dotnet-subset/actions/workflows/workflow.yml/badge.svg?branch=main)](https://github.com/nimbleways/dotnet-subset/actions/workflows/workflow.yml?query=branch%3Amain)
4+
25

36
`dotnet-subset` is a .NET tool that copies a subset of files from a repository to a directory.
47

@@ -24,24 +27,30 @@ Prerequisite: .NET SDK 6
2427
## Usage
2528
```
2629
Description:
27-
Create a subset for the restore operation
30+
Create a subset for the restore operation.
2831
2932
Usage:
30-
dotnet-subset restore <project> [options]
33+
dotnet-subset restore <projectOrSolution> [options]
3134
3235
Arguments:
33-
<project> Project or solution to restore
36+
<projectOrSolution> Project or solution to restore.
3437
3538
Options:
36-
--root-directory <root-directory> (REQUIRED) Directory from where the files will be copied
37-
--output <output> (REQUIRED) Directory where the subset files will be copied, preserving the
38-
original structure.
39+
--root-directory <root-directory> (REQUIRED) Directory from where the files will be copied, usually the
40+
repository's root.
41+
--output <output> (REQUIRED) Directory where the subset files will be copied,
42+
preserving the original hierarchy.
43+
-?, -h, --help Show help and usage information
3944
```
4045

41-
Example:
46+
Example with a project:
4247
```
4348
dotnet subset restore /source/complexapp/complexapp.csproj --root-directory /source/ --output /tmp/restore_subset/
4449
```
50+
Example with a solution:
51+
```
52+
dotnet subset restore /source/complexapp.sln --root-directory /source/ --output /tmp/restore_subset/
53+
```
4554

4655
## dotnet-subset + docker
4756
Please check these pull requests to see how to use `dotnet-subset` in your `Dockerfile`:

0 commit comments

Comments
 (0)