Skip to content

Commit 0526657

Browse files
authored
Merge pull request #189 from bartelink/tidy-readme
Fix broken link
2 parents a452587 + 93ccaae commit 0526657

File tree

1 file changed

+16
-34
lines changed

1 file changed

+16
-34
lines changed

README.md

+16-34
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
FsHttp [![Build & Tests](https://github.com/fsprojects/FsHttp/actions/workflows/build-and-test.yml/badge.svg?branch=master)](https://github.com/fsprojects/FsHttp/actions/workflows/build-and-test.yml) [![NuGet Badge](https://buildstats.info/nuget/FsHttp)](https://www.nuget.org/packages/FsHttp)
1+
# FsHttp [![Build & Tests](https://github.com/fsprojects/FsHttp/actions/workflows/build-and-test.yml/badge.svg?branch=master)](https://github.com/fsprojects/FsHttp/actions/workflows/build-and-test.yml) [![NuGet Badge](https://buildstats.info/nuget/FsHttp)](https://www.nuget.org/packages/FsHttp)
22

3-
<p align="center">
4-
<img src='https://raw.githubusercontent.com/fsprojects/FsHttp/master/docs/img/logo_big.png' alt='logo' width='300' />
5-
</p>
3+
<img align="right" width="200" alt='logo' src='https://raw.githubusercontent.com/fsprojects/FsHttp/master/docs/img/logo_big.png' />
64

7-
FsHttp ("Full Stack HTTP") is a "hackable HTTP client" that enables expressing HTTP requests in a legible style, while still being able to access the underlying Http representations for covering unusual cases. It's the best of both worlds: **Convenience and Flexibility**.
5+
FsHttp ("Full Stack HTTP") is a "hackable HTTP client" that offers a legible style for the basics while still affording full access to the underlying HTTP representations for covering unusual cases. It's the best of both worlds: **Convenience and Flexibility**.
86

97
* Use it as a replacement for `.http` files, *VSCode's REST client*, *Postman*, and other tools as an **interactive and programmable playground** for HTTP requests.
10-
* Usable as a **production-ready HTTP client** for applications powered by .Net (C#, VB, F#).
8+
* Usable as a **production-ready HTTP client** for applications powered by .NET (C#, VB, F#).
119

12-
👍Postman? ❤️ FsHttp! https://youtu.be/F508wQu7ET0
10+
👍 Postman? ❤️ FsHttp! https://youtu.be/F508wQu7ET0
1311

14-
**FsHttp** is developed and maintained by [@SchlenkR](https://github.com/schlenkr) and [@dawedawe](https://github.com/dawedawe). Feel free to leave us a message.
12+
Developed and maintained by [@SchlenkR](https://github.com/schlenkr) and [@dawedawe](https://github.com/dawedawe). Feel free to leave us a message.
1513

16-
A Simple Example
17-
----------------
14+
## Documentation
1815

19-
An example in F#:
16+
* 📖 Please see [FsHttp Documentation](https://fsprojects.github.io/FsHttp) site for 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
2020

2121
```fsharp
2222
#r "nuget: FsHttp"
@@ -36,7 +36,7 @@ http {
3636
|> Request.send
3737
```
3838

39-
An example in C#:
39+
### C# syntax example
4040

4141
```csharp
4242
#r "nuget: FsHttp"
@@ -56,28 +56,12 @@ await Http
5656
.SendAsync();
5757
```
5858

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

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

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

8266
**.Net SDK:**
8367

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

84+
## Credits
10085

101-
Credits
102-
-------
103-
104-
* Parts of the code is taken from the [HTTP utilities of FSharp.Data](https://schlenkr.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).
10587
* Credits to all critics, supporters, contributors, promoters, users, and friends.

0 commit comments

Comments
 (0)