Skip to content
This repository was archived by the owner on Mar 1, 2021. It is now read-only.

Commit 30250a8

Browse files
authored
(GH-47) Update readme to reflect upcoming changes
1 parent 7b3745b commit 30250a8

File tree

1 file changed

+7
-40
lines changed

1 file changed

+7
-40
lines changed

README.md

Lines changed: 7 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,15 @@
11
# Cake.DotNetTool.Module
22

3-
Cake.DotNetTool.Module is a Module for Cake, which extends it with a new IPackageInstaller for installing tools using the dotnet cli.
3+
The Cake.DotNetTool.Module started out as an experiment to see how it would be possible to install .NET Tools using the Cake pre-processor directive. This experiment turned out to be a success, and as a result, this module has now been integrated into the [main Cake repository](https://github.com/cake-build/cake/pull/3207).
44

5-
[![License](http://img.shields.io/:license-mit-blue.svg)](http://cake-contrib.mit-license.org)
5+
Starting with Cake [v1.1.0](https://github.com/cake-build/cake/milestone/77?closed=1) this module will be released as part of the Cake release, as an official NuGet package under the same ID: [`Cake.DotNetTool.Module`](https://www.nuget.org/packages/Cake.DotNetTool.Module/).
66

7-
## Information
7+
Moving forward issues about this module will be tracked on the [main Cake repo](https://github.com/cake-build/cake/issues).
88

9-
| | Stable | Pre-release |
10-
|---|---|---|
11-
|GitHub Release|-|[![GitHub release](https://img.shields.io/github/release/cake-contrib/Cake.DotNetTool.Module.svg)](https://github.com/cake-contrib/Cake.DotNetTool.Module/releases/latest)|
12-
|NuGet|[![NuGet](https://img.shields.io/nuget/v/Cake.DotNetTool.Module.svg)](https://www.nuget.org/packages/Cake.DotNetTool.Module)|[![NuGet](https://img.shields.io/nuget/vpre/Cake.DotNetTool.Module.svg)](https://www.nuget.org/packages/Cake.Module)|
9+
As such, it will no longer be necessary to include the following:
1310

14-
## Build Status
15-
16-
|Develop|Master|
17-
|:--:|:--:|
18-
|[![Build status](https://ci.appveyor.com/api/projects/status/5h3exd4u8p2k2wpn/branch/develop?svg=true)](https://ci.appveyor.com/project/cakecontrib/cake-dotnettool-module/branch/develop)|[![Build status](https://ci.appveyor.com/api/projects/status/5h3exd4u8p2k2wpn/branch/develop?svg=true)](https://ci.appveyor.com/project/cakecontrib/cake-dotnettool-module/branch/master)|
19-
20-
## Code Coverage
21-
22-
[![Coverage Status](https://coveralls.io/repos/github/cake-contrib/Cake.DotNetTool.Module/badge.svg?branch=develop)](https://coveralls.io/github/cake-contrib/Cake.DotNetTool.Module?branch=develop)
23-
24-
## Quick Links
25-
26-
- [Documentation](https://cake-contrib.github.io/Cake.DotNetTool.Module)
27-
28-
## Discussion
29-
30-
If you have questions, search for an existing one, or create a new discussion on the Cake GitHub repository, using the `extension-q-a` category.
31-
32-
[![Join in the discussion on the Cake repository](https://img.shields.io/badge/GitHub-Discussions-green?logo=github)](https://github.com/cake-build/cake/discussions)
33-
34-
## Build
35-
36-
To build this package we are using Cake.
37-
38-
On Windows PowerShell run:
39-
40-
```powershell
41-
.\build.ps1
4211
```
43-
44-
On Linux/Mac run:
45-
46-
```shell
47-
./build.sh
12+
#module nuget:?package=Cake.DotNetTool.Module&version=0.4.0
4813
```
14+
15+
In your cake scripts, as this will be done automatically. If you do still have this in your cake script, Cake will ignore it, and emit a warning, indicating that you should remove it going forward.

0 commit comments

Comments
 (0)