Tweaked README.md

This commit is contained in:
2020-09-19 09:38:32 +10:00
parent 422fff090c
commit cd7e34c11b

View File

@@ -1,7 +1,37 @@
# Things That Need To Be Done
* GitHub CI testing
* Updade the README
* Implement the create command
* Implement the update command
* Implement the delete command
# sineQL
sineQL is a web API query language that mimics graphQL, designed solely for fun.
sineQL consists of two languages - the schema language, and the query language.
You can try the language out right now!
```js
//create the wave function, wrapping a fetch to a server
const wave = body => fetch('https://krgamestudios.com/pokemon', {
method: 'POST',
headers: {
'Content-Type': 'text/plain'
},
body: body
});
//get a list of pokemon names
wave('Pokemon { name }')
.then(blob => blob.text())
.then(text => console.log(text))
.catch(err => console.log(err))
;
```
## The Schema Language
The schema language is a layout of how queries should be made, as well as what can be made with them. There are two built-in keywords for the schema language: