Skip to content

Commit 235ba4a

Browse files
committed
README update
1 parent ff1170d commit 235ba4a

File tree

1 file changed

+53
-53
lines changed

1 file changed

+53
-53
lines changed

README.md

Lines changed: 53 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ $ npm install smsapi --save
1414

1515
## Przykład użycia
1616

17-
```
17+
```javascript
1818
var SMSAPI = require('smsapi'),
1919
smsapi = new SMSAPI();
2020

@@ -48,7 +48,7 @@ function displayError(err){
4848

4949
var SMSAPI = require('smsapi'),
5050
smsapi = new SMSAPI({
51-
server: https://api2.smsapi.pl/'
51+
server: 'https://api2.smsapi.pl/'
5252
});
5353

5454
smsapi.authentication
@@ -76,25 +76,25 @@ function displayError(err){
7676

7777
```
7878

79-
# Autentykacja
79+
## Autentykacja
8080

8181
Biblioteka pozwala na autentykację zarówno czystym hasłem, jak i hashem md5. Domyślnie używana jest metoda autentykacji [Basic auth](https://en.wikipedia.org/wiki/Basic_access_authentication).
8282

83-
## Przykład autentykacji czystym hasłem
83+
### Przykład autentykacji czystym hasłem
8484

8585
```javascript
8686
var promise = smsapi.authentication
8787
.login('username', 'password');
8888
```
8989

90-
## Przykład autentykacji przy użyciu md5
90+
### Przykład autentykacji przy użyciu md5
9191

9292
```javascript
9393
var promise = smsapi.authentication
9494
.loginHashed('username', '5f4dcc3b5aa765d61d8327deb882cf99');
9595
```
9696

97-
## OAuth
97+
### OAuth
9898

9999
Aby skorzystać z OAuth należy podczas tworzenia obiektu SMSAPI dodać parametr:
100100

@@ -130,70 +130,70 @@ function displayError(err){
130130
}
131131
```
132132

133-
Token można wygenerować w panelu SMSAPI pod adresem: https://ssl.smsapi.pl/webapp#/oauth/manage
133+
Token można wygenerować w panelu SMSAPI pod adresem: [https://ssl.smsapi.pl/webapp#/oauth/manage](https://ssl.smsapi.pl/webapp#/oauth/manage)
134134

135-
# Dokumentacja
135+
## Dokumentacja
136136

137137
Dokumentacja interfejsu REST API znajduje się pod adresem [http://www.smsapi.pl/rest](http://www.smsapi.pl/rest).
138138

139-
Wszystkie odwołania do API zwracają obiekt `Promise` zgodny ze standardem [Promises/A+](https://promisesaplus.com). Użyta implementacja: https://github.com/tildeio/rsvp.js
139+
Wszystkie odwołania do API zwracają obiekt `Promise` zgodny ze standardem [Promises/A+](https://promisesaplus.com). Użyta implementacja: [tildeio/rsvp.js](https://github.com/tildeio/rsvp.js)
140140

141-
## Dostępne operacje
141+
### Dostępne operacje
142142

143143
* message
144-
* sms
145-
* mms
146-
* vms
144+
* sms
145+
* mms
146+
* vms
147147
* points
148-
* get
148+
* get
149149
* sender
150-
* add
151-
* delete
152-
* status
153-
* default
154-
* list
150+
* add
151+
* delete
152+
* status
153+
* default
154+
* list
155155
* hlr
156-
* check
156+
* check
157157
* user
158+
* add
159+
* delete
160+
* update
161+
* get
162+
* list
163+
* contacts
164+
* list
165+
* add
166+
* get
167+
* update
168+
* delete
169+
* fields
170+
* list
158171
* add
159-
* delete
160172
* update
161-
* get
162-
* list
163-
* contacts
173+
* delete
174+
* groups
164175
* list
165176
* add
166177
* get
167178
* update
168179
* delete
169-
* fields
170-
* list
171-
* add
172-
* update
173-
* delete
174-
* groups
175-
* list
176-
* add
177-
* get
178-
* update
179-
* delete
180-
* assignments
181-
* list
182-
* add
183-
* get
184-
* delete
185-
* permissions
186-
* list
187-
* add
188-
* get
189-
* update
190-
* delete
191-
* members
192-
* add
193-
* get
194-
* delete
195-
196-
## Dodatkowe przykłady
180+
* assignments
181+
* list
182+
* add
183+
* get
184+
* delete
185+
* permissions
186+
* list
187+
* add
188+
* get
189+
* update
190+
* delete
191+
* members
192+
* add
193+
* get
194+
* delete
195+
196+
### Dodatkowe przykłady
197197

198198
Dodatkowe przykłady użycia dostępnych operacji można znaleźć w testach (./test).
199199

@@ -207,6 +207,6 @@ $ npm test
207207

208208
```
209209

210-
# Licencja
210+
## Licencja
211211

212212
[Apache 2.0 License](LICENSE)

0 commit comments

Comments
 (0)