Skip to content

Commit

Permalink
Merge pull request #189 from bartelink/tidy-readme
Browse files Browse the repository at this point in the history
Fix broken link
  • Loading branch information
SchlenkR committed Mar 5, 2024
2 parents a452587 + 93ccaae commit 0526657
Showing 1 changed file with 16 additions and 34 deletions.
50 changes: 16 additions & 34 deletions README.md
@@ -1,22 +1,22 @@
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)
# 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)

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

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**.
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**.

* 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.
* Usable as a **production-ready HTTP client** for applications powered by .Net (C#, VB, F#).
* Usable as a **production-ready HTTP client** for applications powered by .NET (C#, VB, F#).

👍Postman? ❤️ FsHttp! https://youtu.be/F508wQu7ET0
👍 Postman? ❤️ FsHttp! https://youtu.be/F508wQu7ET0

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

A Simple Example
----------------
## Documentation

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

### F# syntax example

```fsharp
#r "nuget: FsHttp"
Expand All @@ -36,7 +36,7 @@ http {
|> Request.send
```

An example in C#:
### C# syntax example

```csharp
#r "nuget: FsHttp"
Expand All @@ -56,28 +56,12 @@ await Http
.SendAsync();
```


Documentation
-------------

* 📖 Please see [FsHttp Documentation](https://fsprojects.github.io/FsHttp) site for a detailed documentation.
* 🧪 In addition, have a look at the [Integration Tests](https://github.com/fsprojects/FsHttp/tree/master/src/Tests) that show various library details.


Release Notes / Migrating to new versions
---
### Release Notes / Migrating to new versions

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

GitHub
-------------

Please see [FsHttp on GitHub](https://github.com/fsprojects/FsHttp).


Building
--------
## Building

**.Net SDK:**

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

## Credits

Credits
-------

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

0 comments on commit 0526657

Please sign in to comment.