mirror of
https://github.com/zyphlar/doorlock.git
synced 2024-04-03 21:36:03 +00:00
Readme
This commit is contained in:
parent
07adb87899
commit
db8241f4d3
25
readme.md
25
readme.md
|
@ -83,7 +83,7 @@ npm start
|
||||||
|
|
||||||
...which will run the application locally as well as run the test suite, watching for changes.
|
...which will run the application locally as well as run the test suite, watching for changes.
|
||||||
|
|
||||||
### Testing
|
## Testing
|
||||||
|
|
||||||
We use [Jest][jest] to do testing of the core code in the library. Make sure to write tests for new code or update tests on existing code as needed. Test files are next to their source file named with a `.test.js` extension.
|
We use [Jest][jest] to do testing of the core code in the library. Make sure to write tests for new code or update tests on existing code as needed. Test files are next to their source file named with a `.test.js` extension.
|
||||||
|
|
||||||
|
@ -99,11 +99,7 @@ Run tests watching for changes:
|
||||||
npm run watch-test
|
npm run watch-test
|
||||||
```
|
```
|
||||||
|
|
||||||
### RFID Cards
|
## Useful Details
|
||||||
|
|
||||||
Read cards from Cobot:
|
|
||||||
|
|
||||||
<https://www.cobot.me/api-docs/check-ins#list-check-in-tokens>
|
|
||||||
|
|
||||||
### Useful Commands
|
### Useful Commands
|
||||||
|
|
||||||
|
@ -135,7 +131,24 @@ To find the IP address of your Tessel, download the iOS app Fing and look for a
|
||||||
|
|
||||||
* Make sure to format micro SD to be FAT32!
|
* Make sure to format micro SD to be FAT32!
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Contributions welcome!
|
||||||
|
|
||||||
|
Want to contribute? Submit a Pull Request with your changes!
|
||||||
|
|
||||||
|
Using this in your own project? Let us know by creating an issue in Github!
|
||||||
|
|
||||||
|
## Credits
|
||||||
|
|
||||||
|
Developed by [Dana Woodman][dana] © 2018.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT
|
||||||
|
|
||||||
[cobot]: https://www.cobot.me/
|
[cobot]: https://www.cobot.me/
|
||||||
|
[dana]: http://danawoodman.com
|
||||||
[jest]: https://facebook.github.io/jest
|
[jest]: https://facebook.github.io/jest
|
||||||
[latch]: https://www.amazon.com/gp/product/B00V45GWTI
|
[latch]: https://www.amazon.com/gp/product/B00V45GWTI
|
||||||
[start]: http://tessel.github.io/t2-start
|
[start]: http://tessel.github.io/t2-start
|
||||||
|
|
Loading…
Reference in New Issue
Block a user