diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ce41148 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,10 @@ +Thanks for looking here! We'd love your help. The micro:bit project is only +possible through contributions of companies and individuals around the world. + +This project is managed on GitHub, and the best way to contribute is to jump in +and fix/file issues. + +https://github.com/microbit-foundation/microbit-fs + +If you're interested in working on any of these items, please file an issue +and mention @microbit-carlos. diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 0000000..769e4fc --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1,5 @@ +Thank you to everybody that has contributed to the microbit-fs project: + +Carlos Pereira Atencio (carlos@microbit.org) +Ross Lowe (ross@microbit.org) +Matt Hillsdon (matt.hillsdon@microbit.org) diff --git a/README.md b/README.md index 17e22e1..68c9376 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,18 @@ # micro:bit MicroPython Filesystem -A TypeScript library to manipulate the micro:bit filesystem. +A TypeScript library to manipulate the micro:bit MicroPython filesystem. microbit-fs logo -This library is a Work In Progress. At the moment only the MicroPython filesystem within a hex file is supported. +This library is a Work In Progress. At the moment only the MicroPython +filesystem within a hex file is supported. Raw draft of the docs can be found in [https://microbit-foundation.github.io/microbit-fs/](https://microbit-foundation.github.io/microbit-fs/). + + +## License + +This software is under the MIT open source license. + +SPDX-License-Identifier: MIT