Skip to content

Commit b974b8d

Browse files
authored
Merge pull request #326 from philippwiesemann/fix-readme-typos
Fix typos in README.md
2 parents d595821 + abe46d5 commit b974b8d

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -80,18 +80,18 @@ If it started ok, point your browser at <http://localhost:8080/> and enjoy a web
8080

8181
### Nanolets
8282

83-
Nanolets are like sevlet's only that they have a extremely low profile. They offer an easy to use system for a more complex server application.
84-
This text has to be extrended with an example, so for now take a look at the unit tests for the usage. <https://github.com/NanoHttpd/nanohttpd/blob/master/nanolets/src/test/java/fi/iki/elonen/router/AppNanolets.java>
83+
Nanolets are like servlets only that they have a extremely low profile. They offer an easy to use system for a more complex server application.
84+
This text has to be extended with an example, so for now take a look at the unit tests for the usage. <https://github.com/NanoHttpd/nanohttpd/blob/master/nanolets/src/test/java/fi/iki/elonen/router/AppNanolets.java>
8585

8686
## Status
8787

88-
We are currently in the process of stabilizing NanoHttpd from the many pull requests and feature requests that were integrated over the last few months. The next release will come soon, and there will not be any more "intended" major changes before the next release. If you want to use the bleeding edge version, you can clone it from Github, or get it from sonatype.org (see "Maven dependencies / Living on the edge" below).
88+
We are currently in the process of stabilizing NanoHTTPD from the many pull requests and feature requests that were integrated over the last few months. The next release will come soon, and there will not be any more "intended" major changes before the next release. If you want to use the bleeding edge version, you can clone it from Github, or get it from sonatype.org (see "Maven dependencies / Living on the edge" below).
8989

9090
## Project structure
9191

9292
NanoHTTPD project currently consist of four parts:
9393

94-
* `/core` – Fully functional HTTP(s) server consisting of one (1) Java file, ready to be customized/inherited for your own project
94+
* `/core` – Fully functional HTTP(s) server consisting of one (1) Java file, ready to be customized/inherited for your own project.
9595

9696
* `/samples` – Simple examples on how to customize NanoHTTPD. See *HelloServer.java* for a killer app that greets you enthusiastically!
9797

@@ -107,8 +107,8 @@ NanoHTTPD project currently consist of four parts:
107107
### Core
108108
* Only one Java file, providing HTTP 1.1 support.
109109
* No fixed config files, logging, authorization etc. (Implement by yourself if you need them. Errors are passed to java.util.logging, though.)
110-
* Support for HTTPS (SSL)
111-
* Basic support for cookies
110+
* Support for HTTPS (SSL).
111+
* Basic support for cookies.
112112
* Supports parameter parsing of GET and POST methods.
113113
* Some built-in support for HEAD, POST and DELETE requests. You can easily implement/customize any HTTP method, though.
114114
* Supports file upload. Uses memory for small uploads, temp files for large ones.
@@ -130,19 +130,19 @@ NanoHTTPD project currently consist of four parts:
130130
* File server serves also very long files without memory overhead.
131131
* Contains a built-in list of most common MIME types.
132132
* Runtime extension support (extensions that serve particular MIME types) - example extension that serves Markdown formatted files. Simply including an extension JAR in the webserver classpath is enough for the extension to be loaded.
133-
* Simple [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) support via `--cors` paramater
133+
* Simple [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) support via `--cors` parameter
134134
* by default serves `Access-Control-Allow-Headers: origin,accept,content-type`
135135
* possibility to set `Access-Control-Allow-Headers` by setting System property: `AccessControlAllowHeader`
136136
* _example: _ `-DAccessControlAllowHeader=origin,accept,content-type,Authorization`
137137
* possible values:
138-
* `--cors`: activates CORS support, `Access-Control-Allow-Origin` will be set to `*`
138+
* `--cors`: activates CORS support, `Access-Control-Allow-Origin` will be set to `*`.
139139
* `--cors=some_value`: `Access-Control-Allow-Origin` will be set to `some_value`.
140140

141141
**_CORS argument examples_**
142142

143143

144144
* `--cors=http://appOne.company.com`
145-
* `--cors="http://appOne.company.com, http://appTwo.company.com"`: note the double quotes so that the 2 URLs are considered part of a single argument.
145+
* `--cors="http://appOne.company.com, http://appTwo.company.com"`: note the double quotes so that the two URLs are considered part of a single argument.
146146

147147
## Maven dependencies
148148

@@ -160,11 +160,11 @@ NanoHTTPD is a Maven based project and deployed to central. Most development env
160160

161161
The coordinates for your development environment should correspond to these. When looking for an older version take care because we switched groupId from *com.nanohttpd* to *org.nanohttpd* in mid 2015.
162162

163-
Next it depends what you are useing nanohttpd for, there are tree main usages.
163+
Next it depends what you are using NanoHTTPD for, there are three main usages.
164164

165165
## Gradle dependencies
166166

167-
In gradle you can use nano http the same way because gradle accesses the same central repository:
167+
In gradle you can use NanoHTTPD the same way because gradle accesses the same central repository:
168168

169169
dependencies {
170170
runtime(
@@ -202,15 +202,15 @@ Here you write your own subclass of *fi.iki.elonen.NanoWebSocketServer* to confi
202202

203203
### Develop a custom HTTP file server
204204

205-
For a more classic aproach, perhaps to just create a HTTP server serving mostly service files from your disk, you can use the module with artifactId *nanohttpd-webserver*.
205+
For a more classic approach, perhaps to just create a HTTP server serving mostly service files from your disk, you can use the module with artifactId *nanohttpd-webserver*.
206206

207207
<dependency>
208208
<groupId>org.nanohttpd</groupId>
209209
<artifactId>nanohttpd-webserver</artifactId>
210210
<version>CURRENT_VERSION</version>
211211
</dependency>
212212

213-
The included class *fi.iki.elonen.SimpleWebServer* is intended to be used as a starting point for your own implementation but it also can be used as is. Staring the class as is will start a http server on port 8080 and publishing the current directory.
213+
The included class *fi.iki.elonen.SimpleWebServer* is intended to be used as a starting point for your own implementation but it also can be used as is. Starting the class as is will start a HTTP server on port 8080 and publishing the current directory.
214214

215215
### Living on the edge
216216

@@ -234,18 +234,18 @@ The latest Github master version can be fetched through sonatype.org:
234234
</repository>
235235
</repositories>
236236

237-
### generating an self signed ssl certificate
237+
### generating an self signed SSL certificate
238238

239239
Just a hint how to generate a certificate for localhost.
240240

241241
keytool -genkey -keyalg RSA -alias selfsigned -keystore keystore.jks -storepass password -validity 360 -keysize 2048 -ext SAN=DNS:localhost,IP:127.0.0.1 -validity 9999
242242

243-
This will generate a keystore file named 'keystore.jks' with a self signed certificate for a host named localhost with the ip adress 127.0.0.1 . Now
243+
This will generate a keystore file named 'keystore.jks' with a self signed certificate for a host named localhost with the IP address 127.0.0.1 . Now
244244
you can use:
245245

246246
server.makeSecure(NanoHTTPD.makeSSLSocketFactory("/keystore.jks", "password".toCharArray()), null);
247247

248-
Before you start the server to make Nanohttpd serve https connections, when you make sure 'keystore.jks' is in your classpath .
248+
Before you start the server to make NanoHTTPD serve HTTPS connections, when you make sure 'keystore.jks' is in your classpath.
249249

250250
-----
251251

0 commit comments

Comments
 (0)