Add license-file and crate version

MathisWellmann · Aug 10, 2023 · e14eab1 · e14eab1
1 parent abee480
commit e14eab1
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -7,6 +7,7 @@ description = "The perfect smoother: A discrete-time version of spline smoothing
 keywords = ["smoothing", "signal-processing"]
 categories = ["algorithms", "mathematics", "science"]
 exclude = ["/papers"]
+license-file = "LICENSE"
 
 [dependencies]
 nalgebra = "0.32"

diff --git a/README.md b/README.md
@@ -28,6 +28,13 @@ The savitzky-golay filter does have a nice flat passband,
 but suffers from unsatisfactory high-frequency noise, which is not sufficiently suppressed. 
 This is a particular problem when the derivative of the data is of importance.
 
+### Usage
+To use this smoother in you project, add this to your `Cargo.toml`:
+```toml
+[dependencies]
+whittaker_smoother = "0.1"
+```
+
 ### Further Reading:
 See the [papers](./papers/) folder for two papers showing additional details of the method.