Merge pull request #2 from uts-cic/README-updates

Updates to the README - docs and instructions

README.md

@@ -9,23 +9,26 @@ This is a prototype specification that we are using to drive a conversation forw
 ## Helpful resources to guide the development of this repo
 
 - SoLAR position paper on [Generating Data for LA Ecosystems](https://www.solaresearch.org/wp-content/uploads/2020/09/SoLAR_Position-Paper_2020_09.pdf).
-- The [final report]() from the OLT funded [Learning Analytics beyond the LMS]() project, along with the [GitHub resources]() (which are fairly depreciated now).
-- The JISC LA project and [GitHub resources]() (which are fairly depreciated now).
+- The [xAPI Profiles server](https://profiles.adlnet.gov/) and related documentation.
+- The [final report](https://ltr.edu.au/vufind/Record/365945/Description?print=1) from the OLT funded [Learning Analytics beyond the LMS](https://beyondlms.org/) project, along with the [GitHub resources](https://beyondlms.org/tools/LA-API/) (which are fairly depreciated now).
+- The JISC LA project and [GitHub resources](https://github.com/jiscdev) (which are fairly depreciated now).
 
 
 ## How to contribute
 
-Anyone is free to contribute! However, we will be maintaining If you would like to contribute then you should do something like the following:
+Anyone is free to contribute! If you want to make a suggestion for new endpoints or data formats then you will need to do this via pull requests, as we will be performing reviews of suggestions, and trying to generate a community approach around this specication. If you would like to contribute then you should do something like the following:
 
 1. Copy the URL of the repo and then clone it to your local computer
     `git clone [COPIED URL OF THE REPO]`
 1. Create a new branch for the repo with a helpful name that explains what you are adding and switch to that branch
-    `git branch NEWFEATUREBRANCHNAME`
-    `git checkout NEWFEATUREBRANCHNAME`
+    `git branch NEW_FEATURE_BRANCHNAME`  
+    `git checkout NEW_FEATURE_BRANCHNAME`  
 1. Update the relevant code and/or pages while in your new branch using your favourite editor
 1. Commit the changes you have made to that branch along with a message that explains what you were doing
-    `git add .`
-    `git commit -m "SOMETHING MEANINGFUL HERE"`
+    `git add .`  
+    `git commit -m "A MEANINGFUL COMMENT HERE EXPLAINING WHAT YOU DID"`  
 1. Push these changes back to origin 
-    `git push origin NEWFEATUREBRANCHNAME`
-1. Create a pull request back into the main branch
+    `git push origin NEW_FEATURE_BRANCHNAME`  
+1. Create a pull request back into the main branch on the github site for this repo (i.e. go to the GitHub site for this [repo](https://github.com/uts-cic/university-api) and click on the pull request button that should now appear if you have done everything right!)
+
+If you don't understand what this is all doing and want to find out more then you could look at this quick tutorial on [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) which will give you a quick guide to using git for collaborating over shared repositories.