update links and description

leon-luna-ray · Sep 10, 2023 · fe855fd · fe855fd
1 parent c8ffc02
commit fe855fd
Show file tree

Hide file tree

Showing 3 changed files with 71 additions and 78 deletions.
diff --git a/README.md b/README.md
@@ -1,65 +1,48 @@
-  # ReadMe Generator
+# ReadMe Generator
 
-  ## Description
-  This application is currently being refactored as a web app.
+## Description
 
-  A command line application to seamlessly create a new ReadMe file for your projects quickly! This application will ask you all the right questions to generate a professional quality readme from the command line.
+A command line application to seamlessly create a new ReadMe file for your projects quickly! This application will ask you all the right questions to generate a professional quality readme from the command line.
 
-  [https://readme-generator-rldev.netlify.app/](https://readme-generator-rldev.netlify.app/)
+This project orginally started as a Node.js command line application. I have since refactored it to become a frontend web appliation for easy access.
 
+[![Netlify Status](https://api.netlify.com/api/v1/badges/7104dfd9-1c49-44d3-bf7e-831730ab07c4/deploy-status)](https://app.netlify.com/sites/readme-generator-rldev/deploys)
 
+🚀 [https://readme-generator-rldev.netlify.app/](https://readme-generator-rldev.netlify.app/)
 
-  [![Netlify Status](https://api.netlify.com/api/v1/badges/7104dfd9-1c49-44d3-bf7e-831730ab07c4/deploy-status)](https://app.netlify.com/sites/readme-generator-rldev/deploys)
+## Image
 
-  ## Table of Contents
+![Screenshot](./src/assets/img/screenshot.png)
 
-  * [Image](#image)
-  * [Usage](#usage)
-  * [Technologies](#technologies)
-  * [Known-Bugs](#known-bugs)
-  * [Next-Steps](#next-steps)
-  * [License](#License)
-  * [Contact](#contact)
-  * [Links](#Links)
+## Technologies
+- Vue.js
+- CSS3
+- HTML5
+- JavaScript
+- Netlify
+- TailwindCSS
+- Vite.js
 
-  ## Image
+## Next-Steps
 
-  ![Screenshot](https://github.com/leon-luna-ray/hw09-readme-generator/blob/main/assets/images/app-screenshot.png)
+Further refine and expand the question set.
 
-  ## Usage
-  This application runs on node js from the command line. Once cloned to your machine, open the folder with the index.js file in your integrated terminal and run the command 'node index.js.' Inquirer will then prompt you for all of the questions for what to include in your readme and create the new md file. See the video link below!
+## License
 
-  [Video](https://youtu.be/XI6C2lgj540)
+This project is licensed under the [MIT](https://opensource.org/licenses/MIT) license.
 
-  ## Technologies
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-  - Javascript
-  - Node.js
-  - inquirer npm
+## Contact
 
-  ## Known-Bugs
+### Author: Ray Luna
 
-  Trouble with getting some links to work in the table of contents and the screenshot when rendered by the app. Appears to be fixed but if not can be fixed by entering it manually in the md file.
+If you have any questions about the repo, open an issue or contact me directly at:
 
-  ## Next-Steps
+- E-Mail: leon.luna.ray@gmail.com
+- GitHub: [leon-luna-ray](https://github.com/leon-luna-ray)
 
-  Add functionality to add bullet point lists, add links to technologies section and fix bugs listed above and add additional sections further on as needed.
-
-  ## License
-
-  This project is licensed under the [MIT](https://opensource.org/licenses/MIT) license.
-
-  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-  ## Contact
-
-  ### Author: Ray Luna
-
-  If you have any questions about the repo, open an issue or contact me directly at:
-  - E-Mail: leon.luna.ray@gmail.com
-  - GitHub: [leon-luna-ray](https://github.com/leon-luna-ray)
-
-  ## Links
-
-  - [Project Repository](https://github.com/leon-luna-ray/hw09-readme-generator)
+## Links
 
+- [https://readme-generator-rldev.netlify.app/](https://readme-generator-rldev.netlify.app/)
+- [Project Repository](https://github.com/leon-luna-ray/readme-generator)
diff --git a/src/assets/img/screenshot.png b/src/assets/img/screenshot.png
diff --git a/src/lib/content.js b/src/lib/content.js
@@ -9,16 +9,19 @@ export const content = {
       type: 'text',
       name: 'title',
       prompt: 'What is the project title?',
-      template: (title) => {
-        return `# ${title}`;
+      template: (value) => {
+return `# ${value}`;
       },
     },
     {
       type: 'text',
       name: 'description',
       prompt: 'A short description of the project',
-      template: (title) => {
-        return `# ${title}`;
+      template: (value) => {
+        return `
+## Description
+${value}
+        `;
       },
     },
     // {
@@ -39,43 +42,50 @@ export const content = {
       type: 'text',
       name: 'appUrl',
       prompt: 'What is the project URL?',
-      template: (title) => {
-        return `# ${title}`;
-      },
-    },
-    {
-      type: 'text',
-      name: 'repoUrl',
-      prompt: 'What is the project repo URL?',
-      template: (title) => {
-        return `# ${title}`;
+      template: (value) => {
+        return `
+## Link
+${value}
+            `;
       },
     },
+    // Todo need to move to store to create template
+    // {
+    //   type: 'text',
+    //   name: 'repoUrl',
+    //   prompt: 'What is the project repo URL?',
+    //   template: (value) => {
+    //     return `# ${value}`;
+    //   },
+    // },
     {
       type: 'text',
       name: 'imageUrl',
       prompt: 'What is the project image URL or file path?',
-      template: (title) => {
-        return `# ${title}`;
-      },
-    },
-    {
-      type: 'text',
-      name: 'bugs',
-      prompt: 'A despription of any known bugs',
-      template: (title) => {
-        return `# ${title}`;
-      },
-    },
-    {
-      type: 'text',
-      name: 'nextSteps',
-      prompt: 'Next steps for the project',
-      template: (title) => {
-        return `# ${title}`;
+      template: (value) => {
+        return `
+# Image
+![Screenshot](${value})
+        `;
       },
     },
     // {
+    //   type: 'text',
+    //   name: 'bugs',
+    //   prompt: 'A despription of any known bugs',
+    //   template: (value) => {
+    //     return `# ${value}`;
+    //   },
+    // },
+    // {
+    //   type: 'text',
+    //   name: 'nextSteps',
+    //   prompt: 'Next steps for the project',
+    //   template: (value) => {
+    //     return `# ${value}`;
+    //   },
+    // },
+    // {
     //   type: 'list',
     //   name: 'license',
     //   prompt: 'What kind of license should your project have?',