add Readme

Author: pacman82

Cargo.toml

@@ -5,6 +5,26 @@ authors = ["Markus Klein <markus-klein@live.de>"]
 edition = "2018"
 repository = "https://github.com/pacman82/odbc2parquet"
 documentation = "https://docs.rs/odbc2parquet/"
+license = "MIT"
+
+# A short blurb about the package. This is not rendered in any format when
+# uploaded to crates.io (aka this is not markdown).
+description = "Query an ODBC data source and store the result in a Parquet file."
+
+# This is a list of up to five keywords that describe this crate. Keywords
+# are searchable on crates.io, and you may choose any words that would
+# help someone find this crate.
+keywords = ["odbc", "parquet", "sql"]
+
+# This is a list of up to five categories where this crate would fit.
+# Categories are a fixed list available at crates.io/category_slugs, and
+# they must match exactly.
+categories = ["command-line-utilities"]
+
+# This points to a file under the package root (relative to this `Cargo.toml`).
+# The contents of this file are stored and indexed in the registry.
+# crates.io will render this file and place the result on the crate's page.
+readme = "README.md"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

License

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2020 Markus Klein
+
+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.

README.md

@@ -0,0 +1,28 @@
+# Parquet2Odbc
+
+## Usage
+
+```shell
+odbc2parquet run "Driver={ODBC Driver 17 for SQL Server};Server=localhost;UID=SA;PWD=<YourStrong@Passw0rd>;" "SELECT * FROM Birthdays" out.par1
+```
+
+Use `odbc2parquet --help` to see all option.
+
+## Installation
+
+Currently only deployed via cargo. Use `cargo +nightly install odbc2parquet` to install it.
+
+## Mapping of types
+
+The tool queries the ODBC Data source for type information and maps it to parquet type as such:
+
+| ODBC SQL Type | Parquet Logical Type   |
+|---------------|------------------------|
+| Double        | Double                 |
+| Float         | Float                  |
+| Small Integer | Int16                  |
+| Integer       | Int32                  |
+| Big Int       | Int64                  |
+| Date          | Date                   |
+| Timestamp     | Timestamp Microseconds |
+| All others    | Utf8 Byte Array        |