Improve README Structure

[BatoolMM]

Improve README Structure

Description:

The current README is longer than the average README for an R package (or at least the ones I use). This may impact readability and navigation. In the future, we might consider the following improvements:

1. Add a Table of Contents
2. Remove Redundant Text
3. Move Details to Tutorials Section

This is not urgent or very important at this point. However, I found myself struggling a bit with it last night, though it could just be me.

Rachael additions:

There has been a lot of changes to the package (the code & docs). We need to check that gh pages is up to date with these changes, and adjust according. Also check the formatting of gh pages - sometimes the README renders strangely

[RayStick]

Great suggestions. I like the idea of making the README shorter, and linking to a longer more in depth tutorial on github pages perhaps or read-the-docs.

[RayStick]

I have some ideas on how to improve this - will work on it soon and send a PR :)

[BatoolMM]

Hi @RayStick – I was looking at the README, and it’s quite different from when we first created this issue. It looks much more organised and improved. I think you can go ahead and close the issue. I’m happy to add a Table of Contents to make it easier to navigate.

[RayStick]

Thank you :D
I am getting to know how to use github pages, and will make a few improvements to where information is - can I put you as a reviewer for that PR?

[BatoolMM]

Thank you @RayStick - this is the table of content code if you want to add:

# Table of Contents
1. [What is the `browseMetadata` package?](#what-is-the-browsemetadata-package)
   - [Browse metadata](#browse-metadata)
   - [Map metadata](#map-metadata)
2. [Getting started with `browseMetadata`](#getting-started-with-browsemetadata)
   - [Installation and set-up](#installation-and-set-up)
   - [Demo (using the `R Studio` IDE)](#demo-using-the-r-studio-ide)
     - [`browseMetadata.R`](#browsemetadatar)
     - [`mapMetadata.R`](#mapmetadatar)
3. [Changing the json file input](#changing-the-json-file-input-recommended)
4. [Changing the domain file](#changing-the-domain-file-recommended)
5. [Changing the lookup table](#changing-the-lookup-table-advanced)
6. [Tips and future steps](#tips-and-future-steps)
7. [License](#license)
8. [Citation](#citation)
9. [Contributing](#contributing)

[RayStick]

Thanks! I shall include it