Updated documentation for initial release

Author: oclyke

README.md

@@ -1,8 +1,7 @@
-HyperDisplay Arduino Library
+SparkFun SHTC3 Humidity and Temperature Sensor Library 
 ========================================
 
-Providing uniform drawing and printing functions for a wide range of displays in the Arduino environment
-
+This Arduino library allows you to take Humidity and Temperature readings using the SHTC3 sensor from Sensirion using the standard Wire (I2C) library built into Arduino. This means the library is compatible with any Arduino-compatible board that has I2C hardware. Key features of the library include the ability to return either raw ADC values or flaoting point values in %RH and deg C/deg F, data validity indicators based on CRC checking, and a unified return status format for easy error checking. For advanced users an on-return callback is implemented to illuminate the order of program execution. 
 
 Repository Contents
 -------------------
@@ -19,11 +18,11 @@ Documentation
 
 Products that use this Library 
 ---------------------------------
-
+* [SparkX Humidity Sensor Breakout SHTC3 (Qwiic)](https://www.sparkfun.com/products/15074)
 
 Version History
 ---------------
-
+**1.0.0** - Initial release
 
 License Information
 -------------------

keywords.txt

@@ -30,140 +30,23 @@ checkCRC	KEYWORD2
 # Constants (LITERAL1)
 #######################################
 
-SF_SHTC3	LITERAL1
 SHTC3_ADDR_7BIT	LITERAL1
 SHTC3_ADDR_WRITE	LITERAL1
 SHTC3_ADDR_READ	LITERAL1
 SHTC3_MAX_CLOCK_FREQ	LITERAL1
 SHTC3_CMD_WAKE	LITERAL1
-0x3517	LITERAL1
 SHTC3_CMD_SLEEP	LITERAL1
-0xB098	LITERAL1
 SHTC3_CMD_SFT_RST	LITERAL1
-0x805D	LITERAL1
 SHTC3_CMD_READ_ID	LITERAL1
-0xEFC8	LITERAL1
 SHTC3_CMD_CSE_RHF_NPM	LITERAL1
-0x5C24	LITERAL1
-Clock	LITERAL1
-stretching	LITERAL1
-RH	LITERAL1
-first	LITERAL1
-Normal	LITERAL1
-power	LITERAL1
-mode	LITERAL1
 SHTC3_CMD_CSE_RHF_LPM	LITERAL1
-0x44DE	LITERAL1
-Clock	LITERAL1
-stretching	LITERAL1
-RH	LITERAL1
-first	LITERAL1
-Low	LITERAL1
-power	LITERAL1
-mode	LITERAL1
 SHTC3_CMD_CSE_TF_NPM	LITERAL1
-0x7CA2	LITERAL1
-Clock	LITERAL1
-stretching	LITERAL1
-T	LITERAL1
-first	LITERAL1
-Normal	LITERAL1
-power	LITERAL1
-mode	LITERAL1
 SHTC3_CMD_CSE_TF_LPM	LITERAL1
-0x6458	LITERAL1
-Clock	LITERAL1
-stretching	LITERAL1
-T	LITERAL1
-first	LITERAL1
-Low	LITERAL1
-power	LITERAL1
-mode	LITERAL1
 SHTC3_CMD_CSD_RHF_NPM	LITERAL1
-0x58E0	LITERAL1
-Polling	LITERAL1
-RH	LITERAL1
-first	LITERAL1
-Normal	LITERAL1
-power	LITERAL1
-mode	LITERAL1
 SHTC3_CMD_CSD_RHF_LPM	LITERAL1
-0x401A	LITERAL1
-Polling	LITERAL1
-RH	LITERAL1
-first	LITERAL1
-Low	LITERAL1
-power	LITERAL1
-mode	LITERAL1
 SHTC3_CMD_CSD_TF_NPM	LITERAL1
-0x7866	LITERAL1
-Polling	LITERAL1
-T	LITERAL1
-first	LITERAL1
-Normal	LITERAL1
-power	LITERAL1
-mode	LITERAL1
 SHTC3_CMD_CSD_TF_LPM	LITERAL1
-0x609C	LITERAL1
-Polling	LITERAL1
-T	LITERAL1
-first	LITERAL1
-Low	LITERAL1
-power	LITERAL1
-mode	LITERAL1
 SHTC3_Status_Nominal	LITERAL1
-0	LITERAL1
-The	LITERAL1
-one	LITERAL1
-and	LITERAL1
-only	LITERAL1
-all	LITERAL1
-is	LITERAL1
-good	LITERAL1
-return	LITERAL1
-value	LITERAL1
 SHTC3_Status_Error	LITERAL1
-The	LITERAL1
-most	LITERAL1
-general	LITERAL1
-of	LITERAL1
-error	LITERAL1
-values	LITERAL1
-can	LITERAL1
-mean	LITERAL1
-anything	LITERAL1
-depending	LITERAL1
-on	LITERAL1
-the	LITERAL1
-context	LITERAL1
 SHTC3_Status_CRC_Fail	LITERAL1
-This	LITERAL1
-return	LITERAL1
-value	LITERAL1
-means	LITERAL1
-the	LITERAL1
-computed	LITERAL1
-checksum	LITERAL1
-did	LITERAL1
-not	LITERAL1
-match	LITERAL1
-the	LITERAL1
-provided	LITERAL1
-value	LITERAL1
-SHTC3_Status_ID_Fail	LITERAL1
-This	LITERAL1
-status	LITERAL1
-means	LITERAL1
-that	LITERAL1
-the	LITERAL1
-ID	LITERAL1
-of	LITERAL1
-the	LITERAL1
-device	LITERAL1
-did	LITERAL1
-not	LITERAL1
-match	LITERAL1
-the	LITERAL1
-format	LITERAL1
-for	LITERAL1
-SHTC3	LITERAL1
+SHTC3_Status_ID_Fail	LITERAL1