Add and Update READMEs. Correct Spelling Errors

obumnwabude · obumnwabude · commit 66e1080944cf · 2020-06-09T14:00:03.000+01:00
diff --git a/README.md b/README.md
@@ -1,3 +1,16 @@
 # GitHub Organisation Invitation
 
-A web app that can accept a GitHub username and send them an invitation to join a GitHub Organisation.
+A web app that can send invitations to GitHub users to join a given GitHub organization. The app uses a valid OAuth access token of an admin user in that GitHub organization to send invitations. 
+
+To send an invitation three things must be provided: 
+1. Name of the GitHub organization.
+2. OAuth Access token of an admin in that organization (obtainable in GitHub account settings).
+3. Username of the GitHub user to be invited.
+
+The way this app requires the provision of the above mentioned three items, depend on your choice of version to use. Two versions are available and they require different ways of providing the above three items.
+
+1. ## [Node Monolith Server](/node-monolith)
+In this version, provide an `org.js` file in the root folder that exports a JSON object containing `name` (organization's name) and `token` properties. Host the node server. In its frontend, a GitHub user can enter their `username` and get invited to your organization. They will receive proper feedback, whether they was successfully invited or not and possible reasons for that.
+
+2. ## [Static Web App](/static-frontend)
+In this version, you enter your organization's name on GitHub, an admin's OAuth access token and the username of the GitHub user to be invited, directly in the static frontend of the website and JavaScript will do the invitation. Proper feedback is equally shown directly in the website whether the invitation was successful or not and possible reasons for that.
diff --git a/node-monolith/README.md b/node-monolith/README.md
@@ -1,9 +1,9 @@
-# GitHub Organisation Invitation
+# GitHub Organisation Invitation - Monolith Server Version
 
 A web app that can accept a GitHub username and send them an invitation to join a GitHub Organisation.
 
 ## Add org.js file
-Add an org.js file in the root of this repository for this app to work. The file should export the name of the GitHUB organisation to be joined and an OAuth access token.
+Add an org.js file in the root of this repository for this app to work. The file should export the name of the GitHub organisation to be joined and an OAuth access token.
 
 Only admin members of a GitHub organisation can send an invitation to other GitHub users, to join that organisation.
 The admin member must be authenticated before invitation can be sent. Go to settings in admin's GitHub account and get a new OAuth access token or use an existing token, if you already have one. Create a file in the root of this repository and name it `org.js`.
@@ -18,3 +18,6 @@ module.exports = {
 ```
 
 `org.js` has been added to .gitignore so that credentials are not committed to Git.
+
+## The FrontEnd
+In the home of your app, a GitHub user can enter their `username` and get invited to your organization. They will receive proper feedback, whether they was successfully invited or not and possible reasons for that.
diff --git a/node-monolith/public/index.html b/node-monolith/public/index.html
@@ -9,11 +9,11 @@
 </head>
 <body>
   <noscript>
-    <h2 id="noscript-heading" class="failure">This website requires JavaScript to successfully invite you to the GiHub Organisation. To get invited, enable JavaScript in your browser settings or upgrade or change your browser.</h2>
+    <h2 id="noscript-heading" class="failure">This website requires JavaScript to successfully invite you to the GitHub Organisation. To get invited, enable JavaScript in your browser settings or upgrade or change your browser.</h2>
   </noscript>
   <main>
-    <h1 class="text-center">Github Organisation Invitation</h1>
-    <p class="text-center" id="intro">Enter your Github Username below to get invited to <span class="org">the</span> GitHub Organisation</p>
+    <h1 class="text-center">GitHub Organisation Invitation</h1>
+    <p class="text-center" id="intro">Enter your GitHub Username below to get invited to <span class="org">the</span> GitHub Organisation</p>
     <form method="POST" id="invite">
       <label>
         <input type="text" name="username" minlength="2" placeholder="Username" required>
diff --git a/static-frontend/README.md b/static-frontend/README.md
@@ -0,0 +1,7 @@
+# GitHub Organization Invitation - Static Frontend Version
+
+A website that can accepts a GitHub organization's name, an admin's OAuth access token, and the username of a GitHub user, and sends an invitation to the GitHub user to join the GitHub Organization.
+
+In a Github organization, only admin members can send an invitation to other GitHub users, to join that organization. The admin member must be authenticated before invitation can be sent. Go to settings in admin's GitHub account and get a new OAuth access token or use an existing token, if you already have one. 
+
+To invite a user, enter the organization's name on GitHub, the OAuth access token and the GitHub username of the user to be invited and invite the user. The website gives feedback telling whether invitation was successful or not and possible reasons why the invitation was not successful.
diff --git a/static-frontend/index.html b/static-frontend/index.html
@@ -5,28 +5,28 @@
   <meta name="viewport" content="width=device-width, initial-scale=1"> 
   <link href="https://fonts.googleapis.com/css2?family=Roboto&display=swap" rel="stylesheet">
   <link rel="stylesheet" type="text/css" href="styles.css">
-  <title>Get Invited to the GitHub Organisation</title>
+  <title>Invite a GitHub user to your GitHub Organization</title>
 </head>
 <body>
   <noscript>
     <h2 id="noscript-heading" class="failure">This website requires JavaScript to successfully send invitations. For invitations to be sent, enable JavaScript in your browser settings or upgrade or change your browser.</h2>
   </noscript>
   <main>
-    <h1 class="text-center">Github Organisation Invitation</h1>
-    <p class="text-center" id="intro">Enter the name of the Github organisation to which the Github user is to be invited to, the OAuth Access token of an admin in that organisation on whose behalf the invitation is done, and the username of the Github user to be invited.</p>
+    <h1 class="text-center">GitHub Organization Invitation</h1>
+    <p class="text-center" id="intro">Enter the name of the GitHub organization to which the Github user is to be invited to, the OAuth Access token of an admin in that organization on whose behalf the invitation is done, and the username of the GitHub user to be invited.</p>
     <div id="form-and-message-container">
       <form method="POST" id="invite">
         <label>
-          <input type="text" id="org" name="org" minlength="2" placeholder="Github Organisation's Name" required>
-          <span>Github Organisation's Name</span>
+          <input type="text" id="org" name="org" minlength="2" placeholder="GitHub Organization's Name" required>
+          <span>GitHub Organization's Name</span>
         </label>
         <label>
           <input type="text" id="token" name="token" minlength="32" placeholder="Admin's Access token">
           <span>Admin's Access token</span>
         </label>
         <label>
-          <input type="text" id="username" name="username" minlength="2" placeholder="Github Invitee's Username" required>
-          <span>Github Invitee's Username</span>
+          <input type="text" id="username" name="username" minlength="2" placeholder="GitHub Invitee's Username" required>
+          <span>GitHub Invitee's Username</span>
         </label>
         <div id="button-container"> 
           <button type="submit">Invite User</button>
