Skip to content

Commit bdaad34

Browse files
committed
make docs more prominent
1 parent ac6ed5c commit bdaad34

1 file changed

Lines changed: 10 additions & 26 deletions

File tree

README.md

Lines changed: 10 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,12 @@ FsHttp ("Full Stack HTTP") is a "hackable HTTP client" that offers a legible sty
1111

1212
Developed and maintained by [@SchlenkR](https://github.com/schlenkr) and [@dawedawe](https://github.com/dawedawe). Feel free to leave us a message.
1313

14-
A Simple Example
15-
----------------
14+
### Documentation
1615

17-
An example in F#:
16+
* 📖 Please see [FsHttp Documentation](https://fsprojects.github.io/FsHttp) site for a detailed documentation.
17+
* 🧪 In addition, have a look at the [Integration Tests](https://github.com/fsprojects/FsHttp/tree/master/src/Tests) that show various library details.
18+
19+
### F# syntax example
1820

1921
```fsharp
2022
#r "nuget: FsHttp"
@@ -34,7 +36,7 @@ http {
3436
|> Request.send
3537
```
3638

37-
An example in C#:
39+
### C# syntax example
3840

3941
```csharp
4042
#r "nuget: FsHttp"
@@ -54,28 +56,12 @@ await Http
5456
.SendAsync();
5557
```
5658

57-
58-
Documentation
59-
-------------
60-
61-
* 📖 Please see [FsHttp Documentation](https://fsprojects.github.io/FsHttp) site for a detailed documentation.
62-
* 🧪 In addition, have a look at the [Integration Tests](https://github.com/fsprojects/FsHttp/tree/master/src/Tests) that show various library details.
63-
64-
65-
Release Notes / Migrating to new versions
66-
---
59+
### Release Notes / Migrating to new versions
6760

6861
* See https://www.nuget.org/packages/FsHttp#release-body-tab
6962
* For different upgrade paths, please read the [Migrations docs section](https://fsprojects.github.io/FsHttp/Release_Notes.html).
7063

71-
GitHub
72-
-------------
73-
74-
Please see [FsHttp on GitHub](https://github.com/fsprojects/FsHttp).
75-
76-
77-
Building
78-
--------
64+
### Building
7965

8066
**.Net SDK:**
8167

@@ -95,9 +81,7 @@ For common tasks, there are powershell files located in the repo root:
9581
* `./publish.ps1`: Publishes all packages (FsHttp and it's integration packages for Newtonsoft and FSharp.Data) to NuGet.
9682
* Always have a look at `./src/Directory.Build.props` and keep the file up-to-date.
9783

84+
### Credits
9885

99-
Credits
100-
-------
101-
102-
* Parts of the code is taken from the [HTTP utilities of FSharp.Data](https://fsprojects.github.io/FSharp.Data/library/Http.html).
86+
* Parts of the code were taken from the [HTTP utilities of FSharp.Data](https://fsprojects.github.io/FSharp.Data/library/Http.html).
10387
* Credits to all critics, supporters, contributors, promoters, users, and friends.

0 commit comments

Comments
 (0)