Skip to content
This repository was archived by the owner on Feb 3, 2025. It is now read-only.

Commit d41ad23

Browse files
Merge pull request #69 from josemoracard/jose1-readme
fixed text README.md
2 parents a1c6ece + 7f9b176 commit d41ad23

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Hello World with Vanilla JS
22

3-
Start coding a JS/HTML/CSS website in 30 seconds by opening this template in codespaces (coming soon) or [gitpod](https://gitpod.io#https://github.com/4GeeksAcademy/vanillajs-hello.git).
3+
Start coding a JS/HTML/CSS website in 30 seconds by opening this template in [Codespaces](https://github.com/codespaces/new/?repo=4GeeksAcademy/vanillajs-hello) or [Gitpod](https://gitpod.io#https://github.com/4GeeksAcademy/vanillajs-hello.git).
44

5-
## Before you being
5+
## Before you begin
66

77
Install the packages by typing: `npm install`.
88

@@ -14,7 +14,7 @@ Type on the command line `$ npm run start` and type localhost on the browser.
1414

1515
### Where do I write my code?
1616

17-
It depends on the language, but you have `./src/js/app.js`, `./src/style/index.css` and `./isrc/index.html` respectively, you can add new `.html` as you please, just make sure to include import it on the index.js.
17+
It depends on the language, but you have `./src/app.js`, `./src/style.css` and `./src/index.html` respectively, you can add new `.html` as you please, just make sure to import it on the `app.js`.
1818

1919
> Note: remember that the JS workflow starts inside `window.onload`.
2020
@@ -23,29 +23,29 @@ It depends on the language, but you have `./src/js/app.js`, `./src/style/index.c
2323

2424
### I don't see my changes...
2525

26-
Everytime you change any file inside the `./src` folder the website public URL will automatically refresh the changes (it's a process called hot deploy)
27-
Remember also to refresh cleaning the cache (command+shift+r on mac, control+shift+r on pc & linux)
26+
Everytime you change any file inside the `./src` folder the website's public URL will automatically refresh the changes (it's a process called hot deploy)
27+
Remember also to refresh cleaning the cache (`command+shift+r` on Mac, `control+shift+r` on PC & Linux)
2828

29-
### How do I include more images on my project?
29+
### How do I include more images in my project?
3030

3131
Add them inside the `./src/assets/img` folder and import them from any of your JS files. E.g: `import "../assets/img/rigo-baby.jpg";`
3232

3333
### How do I include more JS files?
3434

35-
Just add the files into the JS folder and import the file/variables into your index.js. E.g: `import myVar from "./file2.js"`
35+
Just add the files into the src folder and import the file/variables into your app.js. E.g: `import myVar from "./file2.js"`
3636

3737
### How do I publish the website?
3838

39-
This boilerplate is 100% compatible with the free github pages hosting. Publish your website by running:
39+
This boilerplate is 100% compatible with the free GitHub pages hosting. Publish your website by running:
4040

41-
```sh
41+
```bash
4242
$ npm run deploy
4343
```
4444

45-
Very easy and in just one step! Push to your __main__ branch and use the free hosting that comes with [GitHub pages](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/#enabling-github-pages-to-publish-your-site-from-master-or-gh-pages), the project is ready to be published. Remember to choose to run the Github Page from your master branch.
45+
Very easy and in just one step! Push to your __main__ branch and use the free hosting that comes with [GitHub pages](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/#enabling-github-pages-to-publish-your-site-from-master-or-gh-pages), the project is ready to be published. Remember to choose to run the Github Page from your main branch.
4646

4747
### Thank you
4848

4949
This template was built as part of the 4Geeks Academy [Coding Bootcamp](https://4geeksacademy.com/us/coding-bootcamp) by [Alejandro Sanchez](https://twitter.com/alesanchezr) and many other contributors. Find out more about our [Full Stack Developer Course](https://4geeksacademy.com/us/coding-bootcamps/part-time-full-stack-developer), and [Data Science Bootcamp](https://4geeksacademy.com/us/coding-bootcamps/datascience-machine-learning).
5050

51-
You can find other templates and resources like this at the [school github page](https://github.com/4geeksacademy/).
51+
You can find other templates and resources like this at the [school's GitHub page](https://github.com/4geeksacademy/).

0 commit comments

Comments
 (0)