sjs/mit-license
1
0
Fork 0
mirror of https://github.com/samsonjs/mit-license.git synced 2026-03-25 09:25:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update API usage

Browse source
This commit is contained in:
Richie Bendall 2019-06-01 20:51:33 +12:00
parent 0b0afb9a83
commit fed21bbef0
No known key found for this signature in database
GPG key ID: 1C6A99DFA9D306FC
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -25,6 +25,18 @@ You can send a full JSON file to the API, not _just_ the copyright, so this work
curl -d'{ "copyright": "Remy Sharp", "url": "http://remysharp.com", "email": "me@mysite.com", "format": "txt" }' https://rem.mit-license.org
```
Whilst the command above sends the data as a string which will later be parsed, you can explicitly specify a JSON `Content-Type`:
```bash
curl -H 'Content-Type: application/json' -d'{ "copyright": "Remy Sharp", "url": "http://remysharp.com", "email": "me@mysite.com", "format": "txt" }' https://rem.mit-license.org
```
You can also encode the data as URL query parameters like so:
```bash
curl -X POST "https://rem.mit-license.org/?copyright=Remy%20Sharp&url=http%3A%2F%2Fremysharp.com&email=me%40mysite.com&format=txt"
```
If there's any problems in the automated creation, send me a pull request and it'll go live soon after.
Equally if you need to update the user file to include more details that you didn't initially include (extra fields in the next section) you will need to send a pull request on that `user.json` file via GitHub.