doc: Extend README

[mirdono]

This PR extends the service's draft README with concrete contents following the structure defined by the The Documentation System. This PR builds upon the improvements initially proposed in #6 and thereby supersedes that PR.

In addition this PR also fixes several typos that were encountered throughout the codebase while writing the documentation.

TODO

• Document defining and using scopes

Related ticket(s)

• LBRON-334

[Rahien]

I think the work you did here is nothing short of amazing! Is it worth pointing out that you can set the env variable LISP_DYNAMIC_SPACE_SIZE? In an older version of sparql-parser, this wasn't set and it had trouble dealing with a setup with many quite large queries.

[mirdono]

I think the work you did here is nothing short of amazing! Is it worth pointing out that you can set the env variable LISP_DYNAMIC_SPACE_SIZE? In an older version of sparql-parser, this wasn't set and it had trouble dealing with a setup with many quite large queries.

Thanks I overlooked there is actually one environment variable for this service. I added a section in Reference.

[erikap]

Thanks a lot @mirdono ! 🙏