docs: Add more info to README and update copyright year.

Author: microbit-carlos

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2020 Micro:bit Educational Foundation
+Copyright (c) 2019-2021 Micro:bit Educational Foundation and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -6,14 +6,21 @@ A TypeScript library to manipulate the micro:bit MicroPython filesystem.
 
 <img width="50%" alt="microbit-fs logo" src="https://user-images.githubusercontent.com/29712657/53014294-fb95e700-343f-11e9-856e-d70af8870c0c.png">
 
-This library is a Work In Progress. At the moment only the MicroPython
-filesystem within a hex file is supported.
+## Documentation
 
-Raw draft of the docs can be found in
+The docs can be found in
 [https://microbit-foundation.github.io/microbit-fs/](https://microbit-foundation.github.io/microbit-fs/).
 
+## npm Package
+
+To add this package to your project:
+
+```
+npm install @microbit/microbit-fs
+```
+
 ## License
 
 This software is under the MIT open source license.
 
-SPDX-License-Identifier: MIT
+[SPDX-License-Identifier: MIT](LICENSE.md)

config/typedoc.json

@@ -30,7 +30,13 @@
       "url": null
     }, {
       "label": " micro:bit Tech Site ",
-      "url": "https://tech.microbit.org/"
+      "url": "https://tech.microbit.org"
+    }, {
+      "label": " | ",
+      "url": null
+    }, {
+      "label": " GitHub Repo ",
+      "url": "https://github.com/microbit-foundation/microbit-fs/"
     }
   ],
   "outline": [{

docs/index.md

@@ -15,10 +15,25 @@ Manipulate files in a micro:bit MicroPython Intel Hex file.
 {: .fs-6 .fw-300 }
 
 [Quick Guide](quick-guide.html){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 }
+[API](api/){: .btn .btn-purple .mb-4 .mb-md-0 .mr-2 }
 [View it on GitHub](https://github.com/microbit-foundation/microbit-fs/){: .btn .fs-5 .mb-4 .mb-md-0 }
 
 ---
 
-The documentation is currently a work in progress.
+This is the documentation for the micro:bit Filesystem library.
 
-The menu on the left shows you the available documentation.
+This library can be used to add files with Python code (or any other content)
+into a MicroPython hex file, ready to be loaded into a micro:bit.
+
+The reverse process is also provided, being able to read the files encoded in
+the MicroPython filesystem from a hex file.
+
+As part of the micro:bit V2 release this library can also generate
+[Universal Hex](https://github.com/microbit-foundation/spec-universal-hex) files
+to create a singe hex that can be loaded in any micro:bit board.
+
+## Navigation
+
+- ⬆️ The header at the top contains a search bar
+- ⬅️ The menu on the left shows you the available documentation pages
+- ⬇️ If you'd like to contribute to the docs there is an edit link at the footer

src/flash-regions.ts

@@ -25,7 +25,7 @@
  *
  * More information about how this data is added to the MicroPython Intel Hex
  * file can be found in the MicroPython for micro:bit v2 repository:
- *   https://github.com/microbit-foundation/micropython-microbit-v2/blob/40e9bb687eb561cf590d151c6afa35efbcd4fec0/src/addlayouttable.py
+ *   https://github.com/microbit-foundation/micropython-microbit-v2/blob/v2.0.0-beta.3/src/addlayouttable.py
  *
  * @packageDocumentation
  *