Skip to content

Commit c112dcc

Browse files
committed
README and package.json metadata format fixes
1 parent 4948a0e commit c112dcc

File tree

3 files changed

+41
-12
lines changed

3 files changed

+41
-12
lines changed

LICENSE

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,20 @@
11
The MIT License (MIT)
22
Copyright (c) 2016 Jan-Philipp Riethmacher
33

4-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
Permission is hereby granted, free of charge, to any person obtaining a copy
5+
of this software and associated documentation files (the "Software"), to deal
6+
in the Software without restriction, including without limitation the rights
7+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8+
copies of the Software, and to permit persons to whom the Software is
9+
furnished to do so, subject to the following conditions:
510

6-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
11+
The above copyright notice and this permission notice shall be included in all
12+
copies or substantial portions of the Software.
713

8-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20+
SOFTWARE.

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
# Angular2-Token
22

33
## About
4-
Token based authentication service for Angular2. Angular2-Token works best with the
4+
Token based authentication service for Angular2 with multiple user support. Angular2-Token works best with the
55
[devise token auth](https://github.com/lynndylanhurley/devise_token_auth) gem for Rails.
66

77
Angular2-Token is currently in early Alpha. Any contribution is much appreciated.
88

9+
[![npm](https://img.shields.io/npm/l/express.svg?maxAge=2592000)]([![npm](https://img.shields.io/npm/v/npm.svg?maxAge=2592000)]([![npm](https://img.shields.io/npm/l/express.svg?maxAge=2592000)](https://www.npmjs.com/package/angular2-token)))
10+
[![npm](https://img.shields.io/npm/v/npm.svg?maxAge=2592000)]([![npm](https://img.shields.io/npm/l/express.svg?maxAge=2592000)](https://www.npmjs.com/package/angular2-token))
11+
[![npm](https://img.shields.io/npm/dt/express.svg?maxAge=2592000)]([![npm](https://img.shields.io/npm/l/express.svg?maxAge=2592000)]([![npm](https://img.shields.io/npm/v/npm.svg?maxAge=2592000)]([![npm](https://img.shields.io/npm/l/express.svg?maxAge=2592000)](https://www.npmjs.com/package/angular2-token))))
12+
913
## Install
1014
Install Angular2-Token via NPM with
1115
```bash
@@ -70,9 +74,10 @@ Once initialized `Angular2TokenService` offers methods for session management an
7074
### Log In
7175
The logIn method is used to sign in the user with email address and password.
7276
The optional parameter `type` specifies the name of UserType used for this session.
77+
7378
`logIn(email: string, password: string, userType?: string): Observable<Response>`
7479

75-
#### example
80+
#### Example:
7681
```javascript
7782
this._tokenService.login('example@example.com', 'secretPassword', 'ADMIN').subscribe(
7883
res => console.log(res),
@@ -81,10 +86,11 @@ this._tokenService.login('example@example.com', 'secretPassword', 'ADMIN').subsc
8186
```
8287

8388
### Log Out
84-
The logOut destroys the session and deletes the browsers session storage.
89+
The logOut method destroys session and browsers session storage.
90+
8591
`logOut(): Observable<Response>`
8692

87-
#### example
93+
#### Example:
8894
```javascript
8995
this._tokenService.logOut().subscribe(
9096
res => console.log(res),
@@ -94,9 +100,10 @@ this._tokenService.logOut().subscribe(
94100

95101
### Validate Token
96102
Validates the current token with the server.
103+
97104
`validateToken(): Observable<Response>`
98105

99-
#### example
106+
#### Example:
100107
```javascript
101108
this._tokenService.validateToken().subscribe(
102109
res => console.log(res),
@@ -106,9 +113,10 @@ this._tokenService.validateToken().subscribe(
106113

107114
### Change Password
108115
Updates the existing password for the logged in user.
116+
109117
`updatePassword(currentPassword: string, password: string, passwordConfirmation: string): Observable<Response>`
110118

111-
#### example
119+
#### Example:
112120
```javascript
113121
this._tokenService.updatePassword('oldPassword', 'newPassword', 'newPassword').subscribe(
114122
res => console.log(res),
@@ -124,7 +132,7 @@ this._tokenService.updatePassword('oldPassword', 'newPassword', 'newPassword').s
124132
- `delete(path: string): Observable<Response>`
125133
- `patch(path: string, data: any): Observable<Response>`
126134

127-
#### example
135+
#### Example:
128136
```javascript
129137
this._tokenService.get('myResource/1').map(res => res.json()).subscribe(
130138
res => console.log(res),
@@ -133,4 +141,4 @@ this._tokenService.get('myResource/1').map(res => res.json()).subscribe(
133141
```
134142

135143
## License
136-
The MIT License (see the [LICENSE]() file for the full text)
144+
The MIT License (see the [LICENSE](https://github.com/neroniaky/angular2-token/blob/master/LICENSE) file for the full text)

package.json

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,14 @@
1919
"rxjs": "5.0.0-beta.6"
2020
},
2121
"author": "Jan-Philipp Riethmacher <neroniaky@gmail.com>",
22-
"license": "MIT"
22+
"license": "MIT",
23+
"repository" :
24+
{
25+
"type" : "git",
26+
"url" : "git+https://github.com/neroniaky/angular2-token.git"
27+
},
28+
"bugs": {
29+
"url": "https://github.com/neroniaky/angular2-token/issues"
30+
},
31+
"homepage": "https://github.com/neroniaky/angular2-token#readme"
2332
}

0 commit comments

Comments
 (0)