Skip to content

Commit aff4749

Browse files
committed
README formatting.
1 parent b8e4df7 commit aff4749

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
# DocRaptor C# Native Client Library
22

3-
**WARNING: This code is not production ready, you should use [this](http://docraptor.com/documentation/dotnet).**
3+
This is a DLL and NuGet package for using [DocRaptor API](http://docraptor.com/documentation) to convert HTML to PDF and XLSX.
44

5-
This is a NuGet package for using [DocRaptor API](http://docraptor.com/documentation) to convert HTML to PDF and XLSX.
65

76
## Installation
87

98
**Command line**:
10-
```sh
9+
10+
```powershell
1111
nuget.exe install DocRaptor
1212
```
1313

1414
**[Package Manager Console](http://docs.nuget.org/consume/package-manager-console)**:
15-
```
15+
16+
```powershell
1617
Install-Package EntityFramework
1718
```
1819

@@ -53,10 +54,12 @@ class Example {
5354
Docs created like this are limited to 60 seconds to render, check out the [async example](examples/Async.cs) which allows 10 minutes.
5455

5556
We have guides for doing some of the common things:
57+
5658
* [Headers and Footers](https://docraptor.com/documentation/style#pdf-headers-footers) including page skipping
5759
* [CSS Media Selector](https://docraptor.com/documentation/api#api_basic_pdf) to make the page look exactly as it does in your browser
5860
* [Protected Content](https://docraptor.com/documentation/api#api_advanced_pdf) to secure your URLs so only DocRaptor can access them
5961

62+
6063
## More Help
6164

6265
DocRaptor has a lot of more [styling](https://docraptor.com/documentation/style) and [implementation options](https://docraptor.com/documentation/api).
@@ -73,6 +76,7 @@ The generated client needed a few fixes
7376
- `Configuration` had to be set on `ApiClient`
7477
- User agent had to be set
7578

79+
7680
## Release Process
7781

7882
1. `script/test`
@@ -87,6 +91,8 @@ The generated client needed a few fixes
8791
6. Build package using `script/build`
8892
7. `mono vendor/nuget.exe push bin/DocRaptor.x.x.x.nupkg`
8993
8. Use the git tag and make a new release with `bin/*.dll` attached, https://github.com/DocRaptor/docraptor-csharp/releases/new
94+
9. Update documentation on docraptor.com
95+
9096

9197
## Version Policy
9298

0 commit comments

Comments
 (0)