Merge pull request #14 from ryan-summers/release/0.1.0

Cleaning up docs, fixing exports, adding license

Cargo.toml

@@ -7,7 +7,7 @@ edition = "2018"
 description = "A minimal MQTT5 client designed for no_std platforms"
 homepage = "https://github.com/quartiq/minimq"
 repository = "https://github.com/quartiq/minimq"
-documentation = "https://docs.rs//minimq"
+documentation = "https://docs.rs/minimq"
 
 readme = "README.md"
 categories = ["embedded", "no-std", "database", "encoding"]

LICENSE-MIT

@@ -0,0 +1,27 @@
+Copyright (c) 2020 Quartiq GmbH
+Copyright (c) 2020 Ryan Summers
+Copyright (c) 2020 Max Rottenkolber
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

src/lib.rs

@@ -32,10 +32,10 @@
 //! use minimq::{MqttClient, consts, QoS, embedded_nal::{IpAddr, Ipv4Addr}};
 //!
 //! // Construct an MQTT client with a maximum packet size of 256 bytes.
-//! // Connect to a broker at 192.168.0.254. Use a client ID of "test-client".
+//! // Connect to a broker at 192.168.0.254 - Use a client ID of "test".
 //! let client: MqttClient<consts::U256, _> = MqttClient::new(
 //!         IpAddr::V4(Ipv4Addr::new(192, 168, 0, 254)),
-//!         "test-client",
+//!         "test",
 //!         tcp_stack).unwrap();
 //!
 //! let mut subscribed = false;
@@ -70,7 +70,7 @@ use message_types::MessageType;
 pub use properties::Property;
 
 pub use embedded_nal;
-pub use generic_array::typenum as consts;
+pub use generic_array::typenum::consts;
 pub use mqtt_client::{Error, MqttClient, ProtocolError, QoS};
 
 #[cfg(feature = "logging")]