Minor cleanups preparing for publishing 0.6.0 (#45)

* Update .gitignore and commit Cargo.lock

- It's common to commit Cargo.lock now, so that one can
  reproduce issues due to semver incompatible dependency
  updates more easily.
- Add common IDE folders to gitignore.

* Update metadata

Link the repository and readme in the Cargo.toml
and a short crate documentation.

* Add Cargo.lock

* Update src/lib.rs

Co-authored-by: Martin Robinson <[email protected]>
Signed-off-by: Jonathan Schwender <[email protected]>

---------

Signed-off-by: Jonathan Schwender <[email protected]>
Co-authored-by: Martin Robinson <[email protected]>

Author: jschwe

.gitignore

@@ -1,2 +1,3 @@
 target
-Cargo.lock
+.idea
+.vscode

CHANGELOG.md

@@ -1,9 +1,11 @@
-# Unreleased
+# 0.6.0
 
-- Remove miniz dependency and replace with libz bindings (or optionally libz-rs)
-- Update OTS to v0.9.2 (see [upstream ots 0.9.2 release notes])
+- Remove miniz dependency and replace with libz bindings (or optionally libz-rs) (#39)
+- Update OTS to v0.9.2 (see [upstream ots 0.9.2 release notes]) (#40)
 - Update LZ4 to v1.10.0 (#41)
+- Use [brotli-decompressor] instead of vendoring brotli sources (#42)
 
+[brotli-decompressor]: https://github.com/dropbox/rust-brotli-decompressor
 [upstream ots 0.9.2 release notes]: https://github.com/khaledhosny/ots/releases/tag/v9.2.0
 
 # 0.5.2

Cargo.lock

@@ -6,6 +6,8 @@ description = "Sanitiser for untrusted font files"
 build = "build.rs"
 license = "BSD-3-Clause"
 edition = "2015"
+repository = "https://github.com/servo/fontsan"
+readme = "README.md"
 
 [dependencies]
 fontsan-woff2 = { version = "0.1", path = "src/deps/woff2"}

Cargo.toml

@@ -5,6 +5,7 @@ authors = ["The Servo Project Developers"]
 description = "FFI bindings for woff2 for usage in fontsan"
 license = "MIT"
 edition = "2021"
+repository = "https://github.com/servo/fontsan"
 
 [dependencies]
 brotli-decompressor = {  version = "5", features = ["ffi-api"] }

src/deps/woff2/Cargo.toml

@@ -1 +1,6 @@
-extern crate brotli_decompressor;
+//! A woff2 wrapper crate for fontsan
+//!
+//! This is a helper crate for fontsan, which builds woff2 and links it with the
+//! rust brotli-decompressor crate (with the c-ffi).
+
+extern crate brotli_decompressor;

src/deps/woff2/lib.rs

@@ -2,6 +2,10 @@
 //
 // Use of this source code is governed by a BSD-style license
 // that can be found in the LICENSE file.
+//! fontsan - a sanitizer for untrusted font files.
+//!
+//! Currently, this is just a wrapper around
+//! [ots](https://github.com/khaledhosny/ots), which it builds a copy of.
 
 extern crate fontsan_woff2;
 extern crate libc;