Made the program easier to use and updated the readme

Author: cmexdev

README.md

@@ -1,2 +1,7 @@
 # APIpp
 
+Easily embed API systems into your website
+
+## How to use
+
+It's easy! Launch the application (keep in mind the program is not released yet, but you can still try it out) and follow the steps! (hopefully you don't get to overwhelmed, we're working on that as well).

bin/Debug/api++.exe

@@ -38,6 +38,7 @@ int main()
     cout << "Reading prefs file...(FUTURE FEATURE)" << endl;
     cout << "Start new api operation? [Y/N] ";
     cin >> newApiOp;
+    system("cls");
     if (newApiOp == "y" || newApiOp == "Y") {
         cout << "Embed the code directly into a HTML file or put it in a JavaScript file? [H (HTML)/J (JavaScript)] ";
         cin >> fileType;
@@ -61,32 +62,42 @@ int main()
 }
 int apiSys() {
     int fileSys();
+    system("cls");
     cout << "This application currently only supports GitHub's API system." << endl;
     cout << "For your own reference the base URL is https://api.github.com/" << endl;
     cout << "Choose whether you would like to embed a single repository or a list (found using filters). [R (single repo)/L (list of repos) [FUTURE RELEASE] ";
     cin >> repoSearchType;
+    system("cls");
     if (repoSearchType == "R" || repoSearchType == "r") {
         cout << "Please type the owner of the repository you are trying to embed: ";
         cin >> singleRepoOwner;
+        system("cls");
         cout << "Please type the name of the repository you are trying to embed: ";
         cin >> singleRepoName;
+        system("cls");
         singleUrl = "https://api.github.com/repos/" + singleRepoOwner + "/" + singleRepoName;
         cout << "This is the URL api++ will be using: " << singleUrl << endl;
         cout << "Here is the repo HTML URL (the URL a user would go to view the repo.)" << endl;
         repoHtmlUrl = "https://github.com/" + singleRepoOwner + "/" + singleRepoName;
         cout << repoHtmlUrl << endl;
+        system("pause");
+        system("cls");
 
         cout << "api++ needs to know what parts of the repo you will want to be displayed." << endl;
         cout << "Include title? [Y/N] ";
         cin >> repoName;
+        system("cls");
         cout << "Include the full name? [Y/N] ";
         cin >> repoFullName;
+        system("cls");
         cout << "Include the description? [Y/N] ";
         cin >> repoDesc;
+        system("cls");
         return fileSys();
     }
     else {
         cout << "Sorry! The only option you have right now is to embed one repository at a time. Make sure to type R next time." << endl;
+        system("cls");
         return apiSys();
     }
 }
@@ -96,13 +107,16 @@ int fileSys() {
         if (javascriptFile == true) {
             cout << "What should the JavaScript file be named? (no spaces) ";
             cin >> fileName;
+            system("cls");
         }
         else if (javascriptFile == false) {
             cout << "What should the HTML file be named? (no spaces) ";
             cin >> fileName;
+            system("cls");
         }
         cout << "Where should the file be placed? (no spaces) ";
         cin >> filePath;
+        system("cls");
         if (javascriptFile == true) {
             fullFilePath = filePath + "\\\\" + fileName + ".js";
         }
@@ -112,6 +126,7 @@ int fileSys() {
         cout << "Is this good? [Y/N]" << endl;
         cout << fullFilePath << endl;
         cin >> fullFilePathConfirm;
+        system("cls");
 
         if (fullFilePathConfirm == "Y" || fullFilePathConfirm == "y") {
             ofstream file((fullFilePath).c_str());
@@ -136,7 +151,9 @@ int fileSys() {
 
             cout << "For this code to work the code needs to place the results in a HTML element with a certain ID value. What should that value be? (no spaces) ";
             cin >> fileIdValue;
+            system("cls");
             cout << "ID value: " << fileIdValue << endl;
+            system("cls");
 
             file << "const apiresult = document.getElementById('" << fileIdValue << "');" << endl;
             file << "console.log('api++ system working...')" << endl;
@@ -149,13 +166,15 @@ int fileSys() {
                 file << "console.log('name result: ' + result.name)" << endl;
                 cout << "Should the title element have link? [C (custom link)/R (repo link)/N (no)" << endl;
                 cin >> fileTitleLink;
+                system("cls");
                 if (fileTitleLink == "R" || fileTitleLink == "r") {
                     file << "const title = document.createElement('a')" << endl;
                     file << "title.href = result.html_url" << endl;
                 }
                 else if (fileTitleLink == "C" || fileTitleLink == "c") {
                     cout << "Custom URL: ";
                     cin >> fileTitleLinkCustom;
+                    system("cls");
                     file << "const title = document.createElement('a')" << endl;
                     file << "title.href = '" << fileTitleLinkCustom << "'" << endl;
                 }
@@ -165,7 +184,9 @@ int fileSys() {
                 file << "title.target = '_blank'" << endl;
                 cout << "What should the class value be for the title? (the class name allows styling with CSS) [no spaces] ";
                 cin >> fileTitleClassName;
+                system("cls");
                 cout << "Class name: " << fileTitleClassName << endl;
+                system("cls");
                 file << "title.className = '" << fileTitleClassName << "'" << endl;
                 file << "title.textContent = result.name" << endl;
                 file << "apiresult.appendChild(title)" << endl;
@@ -176,7 +197,9 @@ int fileSys() {
                 file << "const fullname = document.createElement('p')" << endl;
                 cout << "What should the class value be for the full name? (the class name allows styling with CSS) [no spaces] ";
                 cin >> fileFullNameClassName;
+                system("cls");
                 cout << "Class name: " << fileFullNameClassName << endl;
+                system("cls");
                 file << "fullname.className = '" << fileFullNameClassName << "'" << endl;
                 file << "fullname.textContent = result.full_name" << endl;
                 file << "apiresult.appendChild(fullname)" << endl;
@@ -187,7 +210,9 @@ int fileSys() {
                 file << "const desc = document.createElement('p')" << endl;
                 cout << "What should the class value be for the description? (the class name allows styling with CSS) [no spaces] ";
                 cin >> fileFullNameClassName;
+                system("cls");
                 cout << "Class name: " << fileFullNameClassName << endl;
+                system("cls");
                 file << "desc.className = '" << fileFullNameClassName << "'" << endl;
                 file << "desc.textContent = result.description" << endl;
                 file << "apiresult.appendChild(desc)" << endl;