Adds library.properties and prepares for publishing library to Arduin…

…o Library Manager

README.md

@@ -74,7 +74,7 @@ Simply reading the raw values does not provide context or continuity (e.g. we do
 
 ## TODOs
 ### Refactoring
- - Define proper single name to be used for Arduino Library manager, repository, etc
+ - ~~Define proper single name to be used for Arduino Library manager, repository, etc~~
  - Get rid of arduino platform dependencies
  - Write unit tests
  - Decouple algorithm from the entrypoint module
@@ -87,10 +87,17 @@ Simply reading the raw values does not provide context or continuity (e.g. we do
  - where a value followed by a bigger value is treated as a separate signal
  - Handle micros() reset to 0
 
+### CI
+ - Add merge job on circle CI
+ - Add pull request job on circle CI
+ - Create build scripts
+
 ### Documentation
+ - ~~Publish library to Arduino Library Manager~~
  - Add entry for platform.io
  - Add example with two sensors at the same time (led array)
- - Add sketches/schematics
+ - Add drawings/schematics
+ - Add keywords.txt for highlighting on Arduino IDE
 
 ### Features
  - Provide a calculation of the peak amplitude based on mVolts

library.json

@@ -6,8 +6,15 @@
         "type": "git",
         "url": "https://github.com/funkyfisch/arduino-knock-detector"
     },
-    "version": "1.0",
+    "version": "1.0.0",
+    "author": {
+        "name": "Ioannis Gkikas"
+    },
     "examples": "examples/*/*.ino",
+    "exclude": [
+        "scripts",
+        "test"
+      ],
     "frameworks": "arduino",
     "platforms": [
         "atmelavr",

library.properties

@@ -0,0 +1,11 @@
+name=Knock Detector
+version=1.0.0
+author=Ioannis Gkikas <[email protected]>
+maintainer=Ioannis Gkikas <[email protected]>
+sentence=A non-blocking knock detection library to use with piezo elements
+paragraph=Uses a simple non-blocking algorithm that can be continuously fed with values from an analog pin hooked to a piezo disc. This algorithm can detect knocks and separate those pulses from each other. For more info, check the documentation on Github.
+category=Data Processing
+url=https://github.com/funkyfisch/arduino-knock-detector
+architectures=*
+repository=https://github.com/funkyfisch/arduino-knock-detector.git
+license=MIT