Update README.md
This commit is contained in:
		
							parent
							
								
									e9f2584607
								
							
						
					
					
						commit
						4255c8b03b
					
				
							
								
								
									
										20
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										20
									
								
								README.md
									
									
									
									
									
								
							| @ -3,13 +3,14 @@ | |||||||
| A set of [Rust] crates (libraries) for interacting with the [Matrix] chat | A set of [Rust] crates (libraries) for interacting with the [Matrix] chat | ||||||
| network. | network. | ||||||
| 
 | 
 | ||||||
| [website] • [chat] • [unstable documentation][docs] | [website] • [chat] • [unstable documentation][unstable-docs] | ||||||
| 
 | 
 | ||||||
| [Rust]: https://rust-lang.org/ | [Rust]: https://rust-lang.org/ | ||||||
| [Matrix]: https://matrix.org/ | [Matrix]: https://matrix.org/ | ||||||
| [website]: https://www.ruma.io/ | [website]: https://www.ruma.io/ | ||||||
| [chat]: https://matrix.to/#/#ruma:matrix.org | [chat]: https://matrix.to/#/#ruma:matrix.org | ||||||
| [docs]: https://docs.ruma.io/ | [docs]: https://docs.rs/ruma/ | ||||||
|  | [unstable-docs]: https://docs.ruma.io/ | ||||||
| 
 | 
 | ||||||
| ## Getting started | ## Getting started | ||||||
| 
 | 
 | ||||||
| @ -19,13 +20,18 @@ and many other useful things. | |||||||
| 
 | 
 | ||||||
| For homeservers, bridges and harder-to-categorize software that works with | For homeservers, bridges and harder-to-categorize software that works with | ||||||
| Matrix, you're at the right place. To get started, add `ruma` to your | Matrix, you're at the right place. To get started, add `ruma` to your | ||||||
| dependencies (as a git dependency if you want all of the latest improvements). | dependencies: | ||||||
|  | 
 | ||||||
|  | ```toml | ||||||
|  | # crates.io release | ||||||
|  | ruma = { version = "0.1", features = [...] } | ||||||
|  | # git dependency (the next branch contains some breaking changes main doesn't) | ||||||
|  | ruma = { git = "https://github.com/ruma/ruma", branch = "next", features = [...] } | ||||||
|  | ``` | ||||||
| 
 | 
 | ||||||
| `ruma` re-exports all of the other crates, so you don't have to worry about | `ruma` re-exports all of the other crates, so you don't have to worry about | ||||||
| them. Check out [docs.ruma.io](https://docs.ruma.io/ruma/index.html) for the | them. Check out the documentation [on docs.rs][docs] (or on | ||||||
| latest documentation including which Cargo features you have to enable for the | [docs.ruma.io][unstable-docs] if you use use the git dependency). | ||||||
| functionality you want. If you are using a released version from crates.io, you |  | ||||||
| can also find versioned documentation [on docs.rs](https://docs.rs/ruma/). |  | ||||||
| 
 | 
 | ||||||
| [matrix-rust-sdk]: https://github.com/matrix-org/matrix-rust-sdk#readme | [matrix-rust-sdk]: https://github.com/matrix-org/matrix-rust-sdk#readme | ||||||
| [feat]: https://github.com/ruma/ruma/blob/1166af5a354210dcbced1eaf4a11f795c381d2ec/ruma/Cargo.toml#L35 | [feat]: https://github.com/ruma/ruma/blob/1166af5a354210dcbced1eaf4a11f795c381d2ec/ruma/Cargo.toml#L35 | ||||||
|  | |||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user