Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Wording #123

Merged
merged 14 commits into from Jul 20, 2017
Merged

Wording #123

Changes from 5 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
efa0bbf
Change wording so it makes sense
Jul 9, 2017
99775fb
Fix spacing error
Jul 9, 2017
d8391da
Fix spacing
Jul 9, 2017
d00fb1e
Update Usage Instructions
Jul 10, 2017
225c5b4
Add link to license
Jul 10, 2017
6bacf6f
Change LICENSE link to relative
Jul 10, 2017
a1438d2
Remove brackets
Jul 10, 2017
0201f6f
Add js formatting for #api-for-express
Jul 11, 2017
ff85792
Shorten `\`\`\`javascript` to `\`\`\`js`
Jul 11, 2017
ab7340b
Change ```js back to ```javascript
Jul 11, 2017
3140125
Changing sample app to relative
Jul 11, 2017
6fca6fe
Fix formatting error from javscript to javascript
Jul 11, 2017
1347065
Fix spacing in tables
Jul 11, 2017
75bfa74
Fix table formatting
Jul 13, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Reload works in two different ways depending on if you're using it:

Once reload-server and reload-client are connected, the client side code opens a [WebSocket](https://en.wikipedia.org/wiki/WebSocket) to the server and waits for the WebSocket to close, once it closes, reload waits for the server to come back up (waiting for a socket on open event), once the socket opens we reload the page.

Updating from version 2 from version 1
Updating to version 2 from version 1
---

Looking for a quick guide to updating reload to version 2? Please refer to our update section [below](#upgrading-to-version-2).
Expand Down Expand Up @@ -109,7 +109,7 @@ server.listen(app.get('port'), function () {
<title>Reload Express Sample App</title>
</head>
<body>
<h1>Reload Express Sample App</h1>
<h1>Reload Express Sample App</h1>
<!-- All you have to do is include the reload script and have it be on every page of your project -->
<script src="/reload/reload.js"></script>
</body>
Expand Down Expand Up @@ -198,21 +198,22 @@ Usage: reload [options]

Options:

-h, --help Output usage information
-V, --version Output the version number
-b, --browser Open in the browser automatically.
-n, --hostname If -b flag is being used, this allows for custom hostnames. Defaults to localhost.
-d, --dir [dir] The directory to serve up. Defaults to current dir.
-e, --exts [extensions] Extensions separated by commas or pipes. Defaults to html,js,css.
-p, --port [port] The port to bind to. Can be set with PORT env variable as well. Defaults to 8080
-s, --start-page [start-page] Specify a start page. Defaults to index.html.
-v, --verbose Turns on logging on the server and client side. Defaults to false.
-h, --help output usage information
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the diff here?

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets try and keep this to just any problems in docs you see like the wording problem. We can spice up and add things at a later time, as I have more doc changes coming later anyways

Copy link
Author

@ghost ghost Jul 10, 2017 •
edited by ghost
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The main difference was adding [verbose] to the line 209, so that it looked exactly like the output from reload -h

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay that sounds good, why the diff on 201 to 208?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There isn't any difference. It might be because I am on linux and it is changing the line endings?

Copy link
Author

@ghost ghost Jul 10, 2017 •
edited by ghost
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I ran reload -h and copied the output straight from the terminal.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see it's the spacing between the first and second columns that is different. This is good though, I like this because it is an exact copy of what reload -h provides.

-V, --version output the version number
-b, --browser Open in the browser automatically.
-n, --hostname [hostname] If -b flag is being used, this allows for custom hostnames. Defaults to localhost.
-d, --dir [dir] The directory to serve up. Defaults to current dir.
-e, --exts [extensions] Extensions separated by commas or pipes. Defaults to html,js,css.
-p, --port [port] The port to bind to. Can be set with PORT env variable as well. Defaults to 8080
-s, --start-page [start-page] Specify a start page. Defaults to index.html
-v, --verbose [verbose] Turning on logging on the server and client side. Defaults to false

```

License
---

(MIT License)
[(MIT License)](https://github.com/alallier/reload/blob/master/LICENSE)
Copy link
Owner

@alallier alallier Jul 10, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anyway to make this relative. Kind of like how I did here in the CHANGELOG Please refer to the full API in the [README](README.md#api-for-express). Should be able to reference the file without the URL. Test it out and let me know

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed. See commit 6bacf6f

Copy link
Author

@ghost ghost Jul 10, 2017 •
edited by ghost
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I make the link to the expressSampleApp a relative link as well? Or if not, at least change the link from jprichardson to alallier.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch, yeah let's doing something with that. I don't know if you can make it relative? Try it out if not, the update from jprichardson to alallier would be great


Copyright 2017

Expand Down