Skip to content

Commit 9e2b77b

Browse files
few changes and add text in about.md
1 parent 02fd104 commit 9e2b77b

File tree

4 files changed

+34
-12
lines changed

4 files changed

+34
-12
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ So specifically, with this add-on, live reload will also work with the following
1515
***[FAQ.md](./docs/FAQ.md)***
1616
<br>
1717

18-
#### The Common Misconceptions
19-
Neither the browser add-on nor the VS Code extension will host a server for: `PHP`, `.NET` or `NodeJS`. It will give you the *reloading function*, so you do not need to refresh the page every time you save your server-side code.
18+
#### The Common Misconception
19+
Neither the browser add-on nor the VS Code extension will host a server for: `PHP`, `.NET` or `NodeJS`. This add-on will give you the *reloading function*, so you do not need to refresh the page every time you save your server-side code.
2020

2121
<br><hr>
2222

docs/About.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
# About
22

33
### That's why I built this extension.
4-
The reason I built this browser add-on is to delight the experience of server-side programming...lorem ipsum dolor
4+
The reason I built this browser add-on is to delight the experience of server-side programming.
5+
Many of you have probably experienced the frustration when you work with server side code and
6+
that you have to manually update the webpage every time you save the document.
7+
8+
Therefore, I've chosen to build an additional add-on to an already existing vscode extension,
9+
thus providing the option of live reload when working with a particular framework or server.
510

611
<br>
712

@@ -26,15 +31,17 @@ master/
2631
#### manifest.json
2732
The manifest.json file is a JSON-formatted file, and is the only file that every extension using WebExtension APIs must contain.
2833

29-
Using manifest.json, you specify basic metadata about your extension such as the name and version, and can also specify aspects of your extension's functionality, such as background scripts, content scripts, and browser actions.
34+
Using manifest.json, you specify basic metadata about your extension such as the name and version
35+
3036
[Read more...](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/manifest.json)
3137

3238
<br>
3339

3440
#### background.js
3541
Background scripts are the place to put code that needs to maintain long-term state, or perform long-term operations, independently of the lifetime of any particular web pages or browser windows.
3642

37-
Background scripts are loaded as soon as the extension is loaded and stay loaded until the extension is disabled or uninstalled. You can use any of the WebExtension APIs in the script, as long as you have requested the necessary permissions.
43+
Background scripts are loaded as soon as the extension is loaded and stay loaded until the extension is disabled or uninstalled. You can use any of the WebExtension APIs in the script, as long as you have requested the necessary permissions.
44+
3845
[Read more...](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/manifest.json/background)
3946

4047
<br>

docs/FAQ.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,32 @@
66
I'm new to this live-server thing. I have used it for *`.html`* pages, and it worked flawlessly! But now, when I want to use it for php pages, it downloads the .php file instead of executing it.
77

88
**Answer:**
9-
1. [The Common Misconceptions](#the-common-misconceptions)
9+
1. [The Common Misconceptions](#the-common-misconception)
1010
2. You will need to install a server on your machine or download the necessary requirements. Here is a Stackoverflow question: [PHP server on local machine?](https://stackoverflow.com/questions/1678010/php-server-on-local-machine)
1111
+ [PHP](http://php.net/downloads.php) (just the preprocessor without apache)
1212
+ [XAMPP](https://www.apachefriends.org/index.html) (cross-platform)
1313
+ [MAMP](https://www.mamp.info/en/downloads/) (mac)
1414
+ [WAMP](http://www.wampserver.com/en/) (windows)
1515
3. Visit the ***Actual Server Address***: `http://localhost:[port_number]/[workspace]`, not the VS Code extension's ***Live Server Address***: `http://127.0.0.1:5500/`
1616

17-
<br><br><hr>
17+
<br><br><hr><br>
18+
19+
### Why do I have to run a separate server
20+
Hi, I wonder why I have to run my own server when the vscode extension will start one at: `http://127.0.0.1:5500/`, when I go live?
1821

19-
>## The Common Misconceptions
20-
>Neither the browser add-on nor the VS Code extension will host a server for: `PHP`, `.NET` or `NodeJS`. It will give you the *reloading function*, so you do not need to refresh the page every time you save.
22+
**Answer:**
23+
The two main reasons are the flexibility, and the complexity of server-side environment.
24+
For instance, in order to be able to use this add-on in all environments and not to
25+
prevent the user from a specific php verion, or running Apache with PHP.
26+
It is therefore preferable that the user can decide for yourself which environment to use.
27+
Another thing is that the server side is heavier than the client side because it needs a
28+
larger server environment to run- and preprocess your code in PHP, NodeJS or .NET.
29+
30+
<br><br><hr>
31+
>## The Common Misconception
32+
>Neither the browser add-on nor the VS Code extension will host a server for: `PHP`, `.NET` or `NodeJS`.
33+
This add-on will give you the *reloading function*, so you do not need to refresh the webpage every time you save.
2134
>
22-
>The reason I built this browser add-on is to delight the experience of server-side programming. The server-side is heavier than the client-side because it needs a larger server environment to run and preprocess your code in: `PHP`, `NodeJS` or `.NET`.
35+
>The reason I built this browser add-on is to delight the experience of server-side programming.
36+
The server-side is heavier than the client-side because it needs a larger server environment to
37+
run and preprocess your code in: `PHP`, `NodeJS` or `.NET`.

docs/Setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Setup
2-
#### The Common Misconceptions
2+
#### The Common Misconception
33
Neither the browser add-on nor the VS Code extension will host a server for: `PHP`, `.NET` or `NodeJS`. It will give you the *reloading function*, so you do not need to refresh the page every time you save.
44

5-
In other words. If you just want the reload function when you work with .html files, then you do not need this extension at all.
5+
In other words. If you just want the reload feature when working with .html files, then you do not need this add-on at all.
66

77
<br>
88

0 commit comments

Comments
 (0)