Commit Graph

47 Commits

Author SHA1 Message Date
David Pedersen ba4d8a2357
Move axum crate into workspace subfolder (#458)
* Move axum crate into workspace subfolder

Over time I imagine we're gonna have other crates in this repo that
provide utilities or integrations for axum. This prepares for that by
moving the main axum crate into its own folder.

The README situation is a bit annoying because we want `./README.md`
for viewing the repo on github but `axum/README.md` for crates.io. For
now I've just copy/pasted it and added CI step to make sure they're
identical.

* update changelog link

* Add licenses to all examples

* is this how you install `diff`?

* or maybe this is how?

* fix readme links

* like this?

* fix cargo-deny step

* Try making root readme a symlink

* remove compare readme step

not needed since readme in repo root is now a symlink

* Revert "Add licenses to all examples"

This reverts commit ab321b7fb9.
2021-11-03 12:38:48 +01:00
arctic-alpaca a442920ba3
Restructure community showcase (#454) 2021-11-03 09:20:01 +01:00
David Pedersen 5367bc65d1 Fix typo 2021-11-03 08:26:13 +01:00
David Pedersen 708988bfae Fix readme example link 2021-11-03 08:25:31 +01:00
Jordan Gould 1c60255b9f
Add readme example project (#450)
* Add project based on the readme example

* Add readme project link to README.md

* Typo correction

* Update examples/readme-example/Cargo.toml

Use tracing-subscriber 0.2 to match other the other examples

Co-authored-by: David Pedersen <david.pdrsn@gmail.com>

* Update README.md

Use original readme phrasing for crate docs

Co-authored-by: David Pedersen <david.pdrsn@gmail.com>

* Rename readme-exmaple to readme

* Revert tracing call to debug from info

Co-authored-by: Jordan Gould <jordan@tineye.com>
Co-authored-by: David Pedersen <david.pdrsn@gmail.com>
2021-11-03 07:23:28 +00:00
David Pedersen baefa47634 0.3.0 is out! 2021-11-02 18:41:29 +01:00
David Pedersen 9465128f3e
Rework docs (#437)
This reworks axum's docs in an attempt to make things easier to find. Previously I wasn't a fan of those docs for the same topic were spread across the root module docs and more specific places like types and methods.

This changes it such that the root module docs only gives a high level introduction to a topic, perhaps with a small example, and then link to other places where all the details are. This means `Router` is now the single place to learn about routing, and etc for the topics like handlers and error handling.
2021-11-01 21:13:37 +00:00
David Pedersen 857ecd7314
Break root module docs into separate files (#432)
For 0.3 I'm thinking about some changes I wanna make to the docs. I
don't like how information is currently spread over so many places.
Still thinking about how I wanna re-organize it.

However I do think it makes sense to break the root module docs into
separate files that get included with `#![doc = include_str!("file")]`.
Makes working on a single section easier and more focused. It looks the
same for the user reading the docs.

This means axum's MSRV is now 1.54 but since thats two releases ago I'm
fine with that.
2021-10-31 20:37:56 +01:00
Singee e069225559
fix examples link in README.md (#305) 2021-09-06 07:29:32 +00:00
David Pedersen d006b4f6f7 Remove notice about breaking changes in 0.2 from readme 2021-08-23 18:36:34 +02:00
David Pedersen 77f7b51d2f Update readme example to 0.2 2021-08-23 18:36:11 +02:00
David Pedersen c8c8e6509b
Add upgrade examples to the changelog (#245)
Shows how to upgrade

- General routing
- SSE
- WebSockets
2021-08-23 18:24:08 +02:00
David Pedersen 66a806630c Note changes to examples in 0.2 2021-08-21 11:35:57 +02:00
Sagi Sarussi cb637f1124
Fix typo (#202) 2021-08-18 08:02:45 +02:00
David Pedersen 1509d4ad12 Add note about safety to readme 2021-08-05 11:51:33 +02:00
David Pedersen 5c12328892
Replace `hyper::Server` with `axum::Server` in docs (#118)
* Replace `hyper::Server` with `axum::Server` in docs

* Change readme as well
2021-08-04 15:38:51 +02:00
David Pedersen 666d088b26
Including tracing setup in all examples (#79) 2021-08-01 22:01:33 +02:00
David Pedersen 30058dbbed Use `main` for build status in readme 2021-08-01 08:48:31 +02:00
David Pedersen 100ecea581 Mention benchmark in readme 2021-07-31 14:53:12 +02:00
David Pedersen 6c1279a415 Version 0.1.1 2021-07-30 17:20:38 +02:00
David Pedersen 446cfca753 Bring back badges 2021-07-30 17:18:54 +02:00
David Pedersen 5d2580a9d8 Misc readme fixes 2021-07-30 17:17:18 +02:00
David Pedersen 94d2b5f8a6 Misc readme/docs improvements 2021-07-30 15:51:59 +02:00
David Pedersen ba9c03d146 Update links 2021-07-22 19:39:08 +02:00
David Pedersen 9db3b92df4 Remove disclaimer from readme 2021-07-22 15:50:46 +02:00
David Pedersen 7c37bb818a Update goals in readme 2021-07-22 15:44:59 +02:00
David Pedersen 2e2f697f80 Minor docs improvements 2021-07-09 23:39:39 +02:00
David Pedersen 0c19fa4d52 Minor readme improvements 2021-07-09 21:42:41 +02:00
David Pedersen f5fa64dae6 Name is no longer pending 2021-07-09 21:37:44 +02:00
David Pedersen 5a5710d290
Rename to axum (#28) 2021-07-09 21:36:14 +02:00
David Pedersen 7684736817 Fix readme link 2021-06-13 13:11:57 +02:00
David Pedersen 97d9cb2ab7 Tweak readme example 2021-06-13 13:09:24 +02:00
David Pedersen 1002685a20
Rename to `awebframework` (#13) 2021-06-13 11:22:02 +02:00
David Pedersen 002e3f92b3
Misc repo setup (#7) 2021-06-12 20:18:21 +02:00
David Pedersen c91dc7ce29 Make `Request<Body>` an extractor 2021-06-09 09:42:06 +02:00
David Pedersen 1cf78fa807 More docs 2021-06-08 22:04:28 +02:00
David Pedersen d7605d3184 Rebuild readme 2021-06-07 16:32:16 +02:00
David Pedersen 91b1b0bc50 Update docs with nesting 2021-06-06 20:39:54 +02:00
David Pedersen b4e2750d6a Tweak hello world example 2021-06-06 15:26:33 +02:00
David Pedersen 35ab973acb Change readme 2021-06-06 15:24:02 +02:00
David Pedersen d7a0715188 Update readme 2021-06-01 15:12:22 +02:00
David Pedersen c0bf77cbe4 Update readme 2021-06-01 12:12:01 +02:00
David Pedersen 8582c6fd1f Update readme 2021-06-01 00:47:12 +02:00
David Pedersen 0e38037c74 More error handling 2021-06-01 00:37:07 +02:00
David Pedersen 6f5b2708d5 A few more changes 2021-05-31 16:32:56 +02:00
David Pedersen a69ba56ebe Small clarification 2021-05-31 16:30:07 +02:00
David Pedersen f6b1a6f435 More work 2021-05-31 16:28:26 +02:00