Skip to content

Commit 4c924b0

Browse files
committed
update readme
1 parent 4906473 commit 4c924b0

File tree

1 file changed

+26
-16
lines changed

1 file changed

+26
-16
lines changed

Diff for: README.md

+26-16
Original file line numberDiff line numberDiff line change
@@ -29,40 +29,40 @@ Plotly.NET will be available as 2.0.0 version of its predecessor FSharp.Plotly.
2929

3030
Old packages up until version 1.2.2 can be accessed via the old package name *FSharp.Plotly* [here](https://www.nuget.org/packages/FSharp.Plotly/)
3131

32-
### For applications and libraries
32+
The most recent Plotly.NET package is [![](https://img.shields.io/nuget/vpre/Plotly.NET)](https://www.nuget.org/packages/Plotly.NET/).
3333

34-
A preview version of Plotly.NET 2.0.0 is available on nuget to plug into your favorite package manager:
34+
### For applications and libraries
3535

3636
- dotnet CLI
3737

3838
```shell
39-
dotnet add package Plotly.NET --version 2.0.0-alpha5
39+
dotnet add package Plotly.NET <version>
4040
```
4141

4242
- paket CLI
4343

4444
```shell
45-
paket add Plotly.NET --version 2.0.0-beta1
45+
paket add Plotly.NET --version <version>
4646
```
4747

4848
- package manager
4949

5050
```shell
51-
Install-Package Plotly.NET -Version 2.0.0-beta1
51+
Install-Package Plotly.NET -Version <version>
5252
```
5353

5454
Or add the package reference directly to your `.*proj` file:
5555

5656
```
57-
<PackageReference Include="Plotly.NET" Version="2.0.0-beta1" />
57+
<PackageReference Include="Plotly.NET" Version="<version>" />
5858
```
5959

6060
### For scripting
6161

6262
You can include the package via an inline package reference:
6363

6464
```
65-
#r "nuget: Plotly.NET, 2.0.0-beta1"
65+
#r "nuget: Plotly.NET, <version>"
6666
```
6767

6868
### For dotnet interactive notebooks
@@ -71,8 +71,8 @@ You can use the same inline package reference as in script, but as an additional
7171
the interactive extensions for dotnet interactive have you covered for seamless chart rendering:
7272

7373
```
74-
#r "nuget: Plotly.NET, 2.0.0-beta1"
75-
#r "nuget: Plotly.NET.Interactive, 2.0.0-beta1"
74+
#r "nuget: Plotly.NET, <version>"
75+
#r "nuget: Plotly.NET.Interactive, <version>"
7676
```
7777

7878
# Documentation
@@ -89,26 +89,36 @@ The documentation for this library is automatically generated (using FSharp.Form
8989

9090
# Development
9191

92+
_Note:_ The `release` and `prerelease` build targets assume that there is a `NUGET_KEY` environment variable that contains a valid Nuget.org API key.
93+
9294
### build
9395

9496
Check the [build.fsx file](https://github.com/plotly/Plotly.NET/blob/dev/build.fsx) to take a look at the build targets. Here are some examples:
9597

9698
```shell
9799
# Windows
98100

99-
# Build, test, pack nuget, build docs
100-
./build.cmd -t all
101-
102101
# Build only
103102
./build.cmd
104103

105-
# Linux/mac
104+
# Full release buildchain: build, test, pack, build the docs, push a git tag, publsih thze nuget package, release the docs
105+
./build.cmd -t release
106+
107+
# The same for prerelease versions:
108+
./build.cmd -t prerelease
106109

107-
# Build, test, pack nuget, build docs
108-
./build.sh -t all
110+
111+
# Linux/mac
109112

110113
# Build only
111-
./build.sh
114+
build.sh
115+
116+
# Full release buildchain: build, test, pack, build the docs, push a git tag, publsih thze nuget package, release the docs
117+
build.sh -t release
118+
119+
# The same for prerelease versions:
120+
build.sh -t prerelease
121+
112122
```
113123

114124
### docs

0 commit comments

Comments
 (0)