Skip to content

Commit 98f5dd4

Browse files
authored
Update README.md
1 parent 000552e commit 98f5dd4

File tree

1 file changed

+37
-25
lines changed

1 file changed

+37
-25
lines changed

README.md

Lines changed: 37 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@
1414
<!-- PROJECT LOGO -->
1515
<br />
1616
<div align="center">
17-
<img src="nexus/media/logo.png" alt="NexusLogo" width="100%">
18-
17+
<a href="https://github.com/oslabs-beta/Nexus">
18+
<img src="nexus/media/logo.png" alt="NexusLogo" width="100%">
19+
</a>
1920
<!-- HEADING AREA -->
2021
<h1 align="center">Nexus</h1>
2122

@@ -80,28 +81,37 @@ We at Team Nexus hope that you enjoy our extension, taking advantage of a time-t
8081

8182
<!-- BUILT WITH -->
8283
### Built With
84+
<ul>
85+
<li>
86+
<img height="14" src="nexus/media/next-js.png"><a href="Next.js](https://nextjs.org/"> NextJS</a>
87+
</li>
88+
<li>
89+
<img height="14" src="nexus/media/react-brands.png"><a href="https://reactjs.org/"> React</a>
90+
</li>
91+
<li>
92+
<img height="14" src="nexus/media/vscode.png"><a href="https://code.visualstudio.com/api"> VSCode Extension API </a>
93+
</li>
94+
<li>
95+
<img height="14" src="nexus/media/typescript.png"><a href="https://www.typescriptlang.org/"> Typescript </a>
96+
</li>
97+
<li>
98+
<img height="14" src="nexus/media/webpack.png"><a href="https://webpack.js.org/"> Webpack </a>
99+
</li>
100+
<li>
101+
<a href="https://www.npmjs.com/package/acorn"> Acorn-Parser </a>
102+
</li>
103+
</ul>
83104

84-
* <img style="height: 1em;" src="nexus/media/next-js.svg"> [Next.js](https://nextjs.org/)
85-
* <img style="height: 1em;" src="nexus/media/react-brands.svg"> [React.js](https://reactjs.org/)
86-
* <img style="height: 1em;" src="nexus/media/typescript.svg"> [Typescript](https://www.typescriptlang.org/)
87-
* <img style="height: 1em;" src="nexus/media/vscode.svg"> [VSCode Extension API](https://code.visualstudio.com/api)
88-
* <img style="height: 1em;" src="nexus/media/webpack.svg"> [Webpack](https://webpack.js.org/)
89-
* [Acorn Parser](https://www.npmjs.com/package/acorn)
90-
91-
<p align="right">(<a href="#top">back to top</a>)</p>
92105

93106
<!-- INSTALLATION -->
94107
## Installation
95108

96-
1. Download VSCode for your machine: [VSCode Install](https://code.visualstudio.com/download)
109+
1. Install Nexus
97110

98-
2. Install the Nexus extension in the VSCode Marketplace: [here](put download link here)
99-
100-
3. A node tree icon should appear on your sidebar. You've now installed Nexus! Woot Woot! Now on to the "Getting Started" section below.
111+
2. A node tree icon should appear on your sidebar. You've now installed Nexus! Woot Woot! Now on to the "Getting Started" section below.
101112

102113
Note: If contributing, see the "Installation for Contributors" section below!
103114

104-
<p align="right">(<a href="#top">back to top</a>)</p>
105115

106116
<!-- GETTING STARTED -->
107117
## Getting Started
@@ -117,16 +127,24 @@ Nexus supports OSX, Windows, and WSL
117127
## Usage
118128

119129
1. Click the node tree icon on your sidebar. An "Input File Here" button should appear on your side panel!
130+
<br/>
131+
<p align="center">
120132
<img src="nexus/media/gif1.gif">
121-
133+
</p>
134+
<br/>
122135
2. Click the button and your file explorer window will open. Select a file and press "Ok".
136+
<br/>
137+
<p align="center">
123138
<img src="nexus/media/gif2.gif">
139+
</p>
140+
<br/>
124141

125142
3. Your side panel should now render a component tree that displays SSG or SSR status! Clicking on components will render child components if they exist and hovering over components will display their props objects. Enjoy!
143+
<br/>
144+
<p align="center">
126145
<img src="nexus/media/gif3.gif">
127-
128-
<p align="right">(<a href="#top">back to top</a>)</p>
129-
146+
</p>
147+
<br/>
130148

131149

132150
<!-- ROADMAP -->
@@ -141,7 +159,6 @@ Nexus supports OSX, Windows, and WSL
141159

142160
See the [open issues](https://github.com/oslabs-beta/Nexus/issues) for a full list of proposed features (and known issues).
143161

144-
<p align="right">(<a href="#top">back to top</a>)</p>
145162

146163

147164
<!-- STEPS TO CONTRIBUTE -->
@@ -159,7 +176,6 @@ Don't forget to give the project a star! Thanks again!
159176
5. Push to the Branch (`git push origin <github_username>/<YourAmazingFeature>`)
160177
6. Open a Pull Request
161178

162-
<p align="right">(<a href="#top">back to top</a>)</p>
163179

164180
<!-- MAKING CHANGES -->
165181
### Making Changes
@@ -170,14 +186,12 @@ Don't forget to give the project a star! Thanks again!
170186
4. Press F5. A new VSCode window should open. This is your debugging environment!
171187
5. Repeat step 3 and refresh your debugging environment to test further changes
172188

173-
<p align="right">(<a href="#top">back to top</a>)</p>
174189

175190
<!-- LICENSE -->
176191
## License
177192

178193
Distributed under the MIT License. See `LICENSE` for more information.
179194

180-
<p align="right">(<a href="#top">back to top</a>)</p>
181195

182196

183197
<!-- THE NEXUS TEAM -->
@@ -196,5 +210,3 @@ Email: [email protected]
196210
Twitter: [@teamnexus_js](https://twitter.com/teamnexus_js)
197211

198212
Website: [https://nexus-js.com/](https://nexus-js.com/)
199-
200-
<p align="right">(<a href="#top">back to top</a>)</p>

0 commit comments

Comments
 (0)