Updated README and library.properties

README.md

@@ -1,10 +1,8 @@
-SparkFun AutoDriver Arduino Library
+Ponoor L6470 Library
 ==========
-[![AutoDriver](https://dlnmh9ip6v2uc.cloudfront.net/images/products/1/1/6/1/1/11611-01_medium.jpg)  
-*AutoDriver (BOB-13752)*](https://www.sparkfun.com/products/13752)
+Arduino library support for STMicroelectronics [L6470](https://www.st.com/en/motor-drivers/l6470.html) chip.
 
-The AutoDriver is a bipolar stepper driver based on the ST Micro L6470 chip.
-It allows a processor to control a single 3A bipolar stepper motor across an 8-45V supply range.
+This library is a modification of the L6470-based SparkFun [AutoDriver library](https://github.com/sparkfun/SparkFun_AutoDriver_Arduino_Library).
 
 Repository Contents
 -------------------
@@ -13,22 +11,16 @@ Repository Contents
 * **keywords.txt** - List of words to be highlighted by the Arduino IDE
 * **library.properties** - Used by the Arduino package manager
 
-Documentation
+Differences from the original library
 -------------------
-* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
-* **[Product Repository](https://github.com/sparkfun/L6470-AutoDriver)** - Main repository (including hardware files) for the AutoDriver board.
-* **[Hookup Guide](https://learn.sparkfun.com/tutorials/getting-started-with-the-autodriver---v13)** - Basic hookup guide for the AutoDriver board.
-
-Version History
--------------------
-
-* [v 1.0.0](https://github.com/sparkfun/SparkFun_AutoDriver_Arduino_Library/tree/V_1.0.0) - Initial release
-* [v 1.3.0](https://github.com/sparkfun/SparkFun_AutoDriver_Arduino_Library/tree/V_1.3.0) - Library release for V 1.3
+- Added `getSpeed()` function
+- Disable interrupts during `getStatus` and `xferParam` to avoid return value collapse for ATSAMD
+- Changed some constants name(`CMD_GET_STATUS`, `REG_STATUS`) to avoid conflicts with other libraries.
 
 License Information
 -------------------
 This product is open source! 
-The code is beerware; if you see me (or any other SparkFun employee) at the local, and you've found our code helpful, please buy us a round!
+The code is beerware; if you see any SparkFun employee at the local, and you've found their code helpful, please buy them a round! 
 Please use, reuse, and modify these files as you see fit. Please maintain attribution to SparkFun Electronics and release anything derivative under the same license.
 
 Distributed as-is; no warranty is given.

library.properties

@@ -1,9 +1,10 @@
 name=Ponoor L6470 Library
-version=0.1.0
+version=1.0.0
 author=Ponoor Experiments Inc <info@ponoor.com>
 maintainer=Kanta Horio <kanta@ponoor.com>
-sentence=L6470 library, modified version of Sparkfun AutoDriver Library
-paragraph=L6470 library, modified version of Sparkfun AutoDriver Library
-category=Other
-url=https://github.com/kanta/Ponoor_L6470_Library
+sentence=STM L6470 stepper driver chip library.
+paragraph=This library is modified from SparkFun AutoDriver library for SAMD support and some other functionalities and compatibilities.
+category=Device Control
+url=https://github.com/ponoor/Ponoor_L6470_Library
 architectures=*
+includes=Ponoor_L6470Library.h