Skip to content
This repository was archived by the owner on Mar 20, 2024. It is now read-only.

Commit 8470389

Browse files
authored
Bare minimum to document latest release (#9)
* Update README, adding warp and hyper integration crates * Bump version number in quickstart This is is a step towards #8.
1 parent 9f77ea9 commit 8470389

File tree

2 files changed

+30
-28
lines changed

2 files changed

+30
-28
lines changed

docs/README.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,25 @@ Juniper is a [GraphQL] server library for Rust. Build type-safe and fast API
44
servers with minimal boilerplate and configuration.
55

66
[GraphQL][graphql] is a data query language developed by Facebook intended to
7-
serve mobile and web application frontends.
7+
serve mobile and web application frontends.
88

9-
Juniper makes it possible to write GraphQL servers in Rust that are
10-
type-safe and blazingly fast. We also try to make declaring and resolving
9+
_Juniper_ makes it possible to write GraphQL servers in Rust that are
10+
type-safe and blazingly fast. We also try to make declaring and resolving
1111
GraphQL schemas as convenient as possible as Rust will allow.
1212

1313
Juniper does not include a web server - instead it provides building blocks to
1414
make integration with existing servers straightforward. It optionally provides a
15-
pre-built integration for the [Iron][iron] and [Rocket] frameworks, including
15+
pre-built integration for the [Hyper][hyper], [Iron][iron], [Rocket], and [Warp][warp] frameworks, including
1616
embedded [Graphiql][graphiql] for easy debugging.
1717

18-
* [Github](https://github.com/graphql-rust/juniper)
19-
* [Cargo crate](https://crates.io/crates/juniper)
20-
* [API Reference][docsrs]
21-
18+
- [Cargo crate](https://crates.io/crates/juniper)
19+
- [API Reference][docsrs]
2220

2321
## Features
2422

2523
Juniper supports the full GraphQL query language according to the
26-
[specification][graphql_spec], including interfaces, unions, schema
27-
introspection, and validations.
24+
[specification][graphql_spec], including interfaces, unions, schema
25+
introspection, and validations.
2826
It does not, however, support the schema language.
2927

3028
As an exception to other GraphQL libraries for other languages, Juniper builds
@@ -40,15 +38,16 @@ Juniper has automatic integration with some very common Rust crates to make
4038
building schemas a breeze. The types from these crates will be usable in
4139
your Schemas automatically.
4240

43-
* [uuid][uuid]
44-
* [url][url]
45-
* [chrono][chrono]
41+
- [uuid][uuid]
42+
- [url][url]
43+
- [chrono][chrono]
4644

4745
### Web Frameworks
4846

49-
* [rocket][rocket]
50-
* [iron][iron]
51-
47+
- [hyper][hyper]
48+
- [rocket][rocket]
49+
- [iron][iron]
50+
- [warp][warp]
5251

5352
## API Stability
5453

@@ -58,15 +57,18 @@ Juniper has not reached 1.0 yet, thus some API instability should be expected.
5857
[graphiql]: https://github.com/graphql/graphiql
5958
[iron]: http://ironframework.io
6059
[graphql_spec]: http://facebook.github.io/graphql
61-
[test_schema_rs]: https://github.com/graphql-rust/juniper/blob/master/src/tests/schema.rs
60+
[test_schema_rs]: https://github.com/graphql-rust/juniper/blob/master/juniper/src/tests/schema.rs
6261
[tokio]: https://github.com/tokio-rs/tokio
62+
[hyper_examples]: https://github.com/graphql-rust/juniper/tree/master/juniper_hyper/examples
6363
[rocket_examples]: https://github.com/graphql-rust/juniper/tree/master/juniper_rocket/examples
6464
[iron_examples]: https://github.com/graphql-rust/juniper/tree/master/juniper_iron/examples
65-
[Rocket]: https://rocket.rs
66-
[book]: https://graphql-rust.github.io/juniper-book
67-
[book_quickstart]: https://graphql-rust.github.io/juniper-book/quickstart.html
65+
[hyper]: https://hyper.rs
66+
[rocket]: https://rocket.rs
67+
[book]: https://graphql-rust.github.io
68+
[book_quickstart]: https://graphql-rust.github.io/quickstart.html
6869
[docsrs]: https://docs.rs/juniper
69-
70+
[warp]: https://github.com/seanmonstar/warp
71+
[warp_examples]: https://github.com/graphql-rust/juniper/tree/master/juniper_warp/examples
7072
[uuid]: https://crates.io/crates/uuid
7173
[url]: https://crates.io/crates/url
7274
[chrono]: https://crates.io/crates/chrono

docs/quickstart.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
This page will give you a short introduction to the concepts in Juniper.
44

5-
Once you are done here, head over to the [Tutorial][tutorial] to learn how to
5+
Once you are done here, head over to the [Tutorial][tutorial] to learn how to
66
use Juniper by creating a full setup step by step, or consult the other chapters
77
for more detailed information.
88

9-
109
## Installation
1110

1211
!FILENAME Cargo.toml
12+
1313
```toml
1414
[dependencies]
15-
juniper = "0.9.0"
15+
juniper = "0.10.0"
1616
```
1717

1818
## Schema example
@@ -23,13 +23,13 @@ naturally map to GraphQL features, such as `Option<T>`, `Vec<T>`, `Box<T>`,
2323
`String`, `f64`, and `i32`, references, and slices.
2424

2525
For more advanced mappings, Juniper provides multiple macros to map your Rust
26-
types to a GraphQL schema. The most important one is the
26+
types to a GraphQL schema. The most important one is the
2727
[graphql_object!][jp_obj_macro] macro that is used for declaring an object with
2828
resolvers, which you will use for the `Query` and `Mutation` roots.
2929

3030
!FILENAME main.rs
31-
```rust
3231

32+
```rust
3333
#[macro_use] extern crate juniper;
3434

3535
use juniper::{FieldResult};
@@ -124,19 +124,19 @@ type Schema = juniper::RootNode<'static, Query, Mutation>;
124124
fn main() {
125125
println!("Hello, world!");
126126
}
127-
128127
```
129128

130129
We now have a very simple but functional schema for a GraphQL server!
131130

132-
To actually serve the schema, see the guides for our [Rocket][rocket_guide] or
131+
To actually serve the schema, see the guides for our [Rocket][rocket_guide] or
133132
[Iron][iron_guide] integrations. Or you can invoke the executor directly:
134133

135134
## Executor
136135

137136
You can invoke `juniper::execute` directly to run a GraphQL query:
138137

139138
!FILENAME main.rs
139+
140140
```rust
141141
#[macro_use] extern crate juniper;
142142

0 commit comments

Comments
 (0)