Skip to content

Commit 19f3a54

Browse files
committed
readme
1 parent 1f393d5 commit 19f3a54

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,32 +14,30 @@ wapp.Run(Response.ofPlainText "Hello world")
1414

1515
[Falco](https://github.com/pimbrouwers/Falco) is a toolkit for building fast and functional-first web applications using F#. You can think of it as [minimal API](https://learn.microsoft.com/en-us/aspnet/core/tutorials/min-web-api?view=aspnetcore-8.0&tabs=visual-studio) on *steroids*.
1616

17-
- Built upon the high-performance components of ASP.NET Core.
18-
- Optimized for building full-stack web applications quickly.
17+
- Designed for building pure F# full-stack web applications.
18+
- Built on the high-performance components of ASP.NET Core.
1919
- Seamlessly integrates with existing .NET Core middleware and libraries.
2020

2121
## Key Features
2222

23-
- Asynchronous [request handling](documentation/response.md).
2423
- Simple and powerful [routing](documentation/routing.md) API.
2524
- Uniform API for [accessing _any_ request data](documentation/request.md).
2625
- Native F# [view engine](documentation/markup.md).
26+
- Asynchronous [request handling](documentation/response.md).
2727
- [Authentication](documentation/authentication.md) and [security](documentation/cross-site-request-forgery.md) utilities.
2828
- Built-in support for [large uploads](documentation/request.md#multipartform-data-binding) and [binary responses](documentation/response.md#content-disposition).
2929

30+
3031
## Design Goals
3132

3233
- Provide a toolset to build full-stack web application in F#.
3334
- Should be simple, extensible and integrate with existing .NET libraries.
3435
- Can be easily learned.
3536

36-
## Learn
37-
38-
The best way to get started is by visiting the [documentation](https://falcoframework.com/docs). For questions and support please use [discussions](https://github.com/pimbrouwers/Falco/discussions). The issue list of this repo is **exclusively** for bug reports and feature requests. For chronological updates refer to the [changelog](CHANGELOG.md) is the best place to find chronological updates.
3937

40-
If you want to stay in touch, feel free to reach out on [Twitter](https://twitter.com/falco_framework).
38+
## Learn
4139

42-
Have an article or video that you want to share? We'd love to hear from you! To add your content, visit this [discussion](https://github.com/pimbrouwers/Falco/discussions/82).
40+
The best way to get started is by visiting the [documentation](https://falcoframework.com/docs). For questions and support please use [discussions](https://github.com/pimbrouwers/Falco/discussions). For chronological updates refer to the [changelog](CHANGELOG.md) is the best place to find chronological updates.
4341

4442
### Related Libraries
4543

@@ -50,7 +48,6 @@ Have an article or video that you want to share? We'd love to hear from you! To
5048

5149
### Community Projects
5250

53-
- [FalcoJournal](https://github.com/pimbrouwers/FalcoJournal) - A bullet journal built with Falco, .NET 5.x and ASP.NET Core.
5451
- [Falco GraphQL Sample](https://github.com/adelarsq/falco_graphql_sample) - A sample showing how to use GraphQL on Falco using .NET 6.
5552
- [Falco API with Tests Sample](https://github.com/jasiozet/falco-api-with-tests-template) - A sample project using Falco and unit testing.
5653
- [Falco + SQLite + Donald](https://github.com/galassie/FalcoSample) - A demo project using Falco, [Donald](https://github.com/pimbrouwers/Donald), and SQLite
@@ -64,26 +61,28 @@ Have an article or video that you want to share? We'd love to hear from you! To
6461

6562
- Ben Gobeil - [Why I'm Using Falco Instead Of Saturn | How To Switch Your Backend In SAFE Stack | StonkWatch Ep.13](https://youtu.be/DTy5gIUWvpo)
6663

67-
## Contribute
6864

69-
Thank you for considering contributing to Falco, and to those who have already contributed! We appreciate (and actively resolve) PRs of all shapes and sizes.
65+
## Contribute
7066

7167
We kindly ask that before submitting a pull request, you first submit an [issue](https://github.com/pimbrouwers/Falco/issues) or open a [discussion](https://github.com/pimbrouwers/Falco/discussions).
7268

7369
If functionality is added to the API, or changed, please kindly update the relevant [document](docs). Unit tests must also be added and/or updated before a pull request can be successfully merged.
7470

75-
Only pull requests which pass all build checks and comply with the general coding guidelines can be approved.
71+
Only pull requests which pass all build checks and comply with the general coding standard can be approved.
7672

7773
If you have any further questions, submit an [issue](https://github.com/pimbrouwers/Falco/issues) or open a [discussion](https://github.com/pimbrouwers/Falco/discussions) or reach out on [Twitter](https://twitter.com/falco_framework).
7874

75+
7976
## Why "Falco"?
8077

8178
[Kestrel](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel) has been a game changer for the .NET web stack. In the animal kingdom, "Kestrel" is a name given to several members of the falcon genus. Also known as "Falco".
8279

80+
8381
## Find a bug?
8482

8583
There's an [issue](https://github.com/pimbrouwers/Falco/issues) for that.
8684

85+
8786
## License
8887

89-
Built with ♥ by [Pim Brouwers](https://github.com/pimbrouwers) in Toronto, ON. Licensed under [Apache License 2.0](https://github.com/pimbrouwers/Falco/blob/master/LICENSE).
88+
Licensed under [Apache License 2.0](https://github.com/pimbrouwers/Falco/blob/master/LICENSE).

0 commit comments

Comments
 (0)