Apply suggestions from code review

Co-Authored-By: David Dias <[email protected]>

Author: AuHau

README.md

@@ -49,6 +49,7 @@ This framework:
  * Defines migrations API
  * Executes and reports migrations in both directions: forward and backward
  * Simplifies creation of new migrations
+ * Works on the browser too!
 
 ## Install
 
@@ -93,7 +94,7 @@ To migrate your repository using the CLI, see the [how to run migrations](./run.
 migrations leaves the user with no way to run the migrations because there is no CLI in the browser. In such
 a case, you should provide a way to trigger migrations manually.**
 
-### Writing migration
+## Creating a new migration
 
 Migrations are one of those things that can be extremely painful on users. At the end of the day, we want users never to have to think about it. The process should be:
 
@@ -106,7 +107,7 @@ If your migration has several parts, it should be fail-proof enough that if one
 are reverted before propagating the error. If possible then the outcome should be consistent repo so it migration could
 be run again. 
 
-#### Architecture of migrations
+### Architecture of a migration
 
 All migrations are placed in the `/migrations` folder. Each folder there represents one migration that follows the migration
 API.
@@ -122,7 +123,7 @@ Each migration must follow this API. It must export an object in its `index.js`
  * `migrate` (function) - Function that performs the migration (see signature of this function below)
  * `revert` (function) - If defined then this function will revert the migration to the previous version. Otherwise it is assumed that it is not possible to revert this migration.
 
-##### `migrate(repoPath, isBrowser)`
+#### `.migrate(repoPath, isBrowser)`
 
 _Do not confuse this function with the `require('ipfs-repo-migrations').migrate()` function that drives the whole migration process!_
 
@@ -131,7 +132,7 @@ Arguments:
  * `options` (object, optional) - object containing `IPFSRepo` options, that should be used to construct a datastore instance.
  * `isBrowser` (bool) - indicates if the migration is run in a browser environment (as opposed to NodeJS)
 
-##### `revert(repoPath, isBrowser)`
+#### `.revert(repoPath, isBrowser)`
 
 _Do not confuse this function with the `require('ipfs-repo-migrations').revert()` function that drives the whole backward migration process!_
 
@@ -182,12 +183,12 @@ reason migrations should be well tested to ensure correct behaviour over depende
 An update of some dependency could introduce breaking change. In such a case the next steps should be discussed with a broader 
 audience. 
 
-#### Integration with js-ipfs
+### Integration with js-ipfs
 
 When a new migration is created, the repo version in [`js-ipfs-repo`](https://github.com/ipfs/js-ipfs-repo) should be updated with the new version,
 together with updated version of this package. Then the updated version should be propagated to `js-ipfs`.
 
-#### Tests
+### Tests
 
 If a migration affects any of the following functionality, it must provide tests for the following functions
  to work under the version of the repo that it migrates to:
@@ -199,7 +200,7 @@ If a migration affects any of the following functionality, it must provide tests
 Every migration must have test coverage. Tests for migrations should be placed in the `/test/migrations/` folder. Most probably
 you will have to plug the tests into `browser.js`/`node.js` if they require specific bootstrapping on each platform.
 
-#### Empty migrations
+### Empty migrations
 
 For interop with go-ipfs it might be necessary just to bump a version of a repo without any actual 
 modification as there might not be any changes needed in the JS implementation. For that purpose you can create an "empty migration".
@@ -221,7 +222,7 @@ This will create an empty migration with the next version.
 
 ## API
 
-### `migrate(path, {toVersion, ignoreLock, repoOptions, onProgress, isDryRun}) -> Promise<void>`
+### `.migrate(path, {toVersion, ignoreLock, repoOptions, onProgress, isDryRun}) -> Promise<void>`
 
 Executes a forward migration to a specific version, or to the latest version if a specific version is not specified.
 
@@ -244,7 +245,7 @@ Signature of the progress callback.
  * `counter` (int) - index of current migration.
  * `totalMigrations` (int) - total count of migrations that will be run.
 
-### `revert(path, toVersion, {ignoreLock, options, onProgress, isDryRun}) -> Promise<void>`
+### `.revert(path, toVersion, {ignoreLock, options, onProgress, isDryRun}) -> Promise<void>`
 
 Executes backward migration to a specific version.
 
@@ -273,7 +274,9 @@ It has several commands:
 
 For further details see the `--help` pages.
 
-## Versioning
+## Developer
+
+### Module versioning notes 
 
 In order to have good overview of what version of package contains what kind of migrations, this package follows this versioning schema: `0.<versionOfLastMigration>.<patches>`.