Skip to content
This repository was archived by the owner on Sep 2, 2024. It is now read-only.

Commit fb00c72

Browse files
committed
fix some typos and table of content links
1 parent f5cb35c commit fb00c72

File tree

1 file changed

+24
-31
lines changed

1 file changed

+24
-31
lines changed

README.md

Lines changed: 24 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,22 @@ vendor lock-in, and your data stays in your control.
1313

1414
### Table of content
1515

16-
* [What can you build](#what-can-you-build)
17-
* [How it works / dev workflow](#how-it-works-dev-workflow)
18-
* [Get started with the self-hosted version](#get-started-with-the-self-hosted-version)
19-
* [Documentation](#documentation)
20-
* [Librairies & CLI](#libraries-cli)
21-
* [Examples](#examples)
22-
* [Deploying in production](#deploying-in-production)
23-
* [Feedback & contributing](#feedback-contributing)
24-
* [Open source, sponsors, paid SaaS](#open-source-sponsors-paid-saas)
25-
* [Spread the words](#spread-the-words)
16+
* [What can you build](#user-content-what-can-you-build)
17+
* [How it works / dev workflow](#user-content-how-it-works--dev-workflow)
18+
* [Get started with the self-hosted version](#user-content-get-started-with-the-self-hosted-version)
19+
* [Documentation](#user-content-documentation)
20+
* [Librairies & CLI](#user-content-librairies--cli)
21+
* [Examples](#user-content-examples)
22+
* [Deploying in production](#user-content-deploying-in-production")
23+
* [Feedback & contributing](#user-content-feedback--contributing")
24+
* [Open source, sponsors, paid SaaS](#user-content-open-source-sponsors-paid-saas")
25+
* [Spread the words](#user-content-spread-the-words")
2626

2727

2828
## What can you build
2929

3030
I built StaticBackend with the mindset of someone tired of writing the same code
31-
over and over on the backend. If you're application needs one or all of
31+
over and over on the backend. If your application needs one or all of
3232
user management, database, file storage, real-time interactions, it should be
3333
a good fit.
3434

@@ -53,15 +53,15 @@ From there each users can create database documents that are by default Read/Wri
5353
for the owner (the user) and Read for its parent account. You may customize
5454
permission for each of your collection (see that later in the documentation).
5555

56-
From here you have the basics building blocks to create a typical web
57-
application. You have all your CRUD and data query operations cover, file
56+
You have the basic building blocks to create a typical web
57+
application. You have all your CRUD and data query operations covered, file
5858
storage and websocket-like capabilities.
5959

60-
We have a [JavaScript](https://www.npmjs.com/package/@staticbackend/js) to
60+
We have a [JavaScript library](https://www.npmjs.com/package/@staticbackend/js) to
6161
get started quickly. We have also server-side libraries for Node and Go atm.
6262

63-
Why would you need server-side libraries, was it not suppose to be a backend
64-
for client-side application.
63+
Why would you need server-side libraries, was it not supposed to be a backend
64+
for client-side applications.
6565

6666
Yes, but, there's always a but. Sometimes your application will need to
6767
perform tasks on behalf of users or public user that do not have access to
@@ -83,13 +83,16 @@ when they click on the unique link on their email they received.
8383
This can be achieve via a backend function. Couple of ways:
8484

8585
* The email the client received can be directly a unique URL pointing to a
86-
function as a service hosted somewhere. (We will have functions soon).
86+
function as a service hosted somewhere. (We will have functions soon). That
87+
function returns the invoice HTML.
8788
* Or it could be pointing to your client-side app and you perform a call to
88-
a serverless function you're hosting somewhere.
89+
a serverless function you're hosting somewhere. That function uses the
90+
server-side library to perform a `GET` on behalf of the creator of the invoice
91+
document, which is our customer.
8992

9093
The function will be able to perform a Read operation using a special `Root Token`.
9194

92-
This Root Token allow your system to do anything in the server-side.
95+
This `Root Token` allows your system to do anything on the server-side.
9396

9497
I hope I did not lost the majority of people here ;)
9598

@@ -129,7 +132,7 @@ We have a page listing our
129132

130133
## Examples
131134

132-
If you'd like to see specifics examples please let us know via the
135+
If you'd like to see specific examples please let us know via the
133136
[Discussions](https://github.com/staticbackendhq/core/discussions) tab.
134137

135138
Here's the examples we have created so far:
@@ -154,16 +157,6 @@ Same for contributing. The easiest is to get in touch first. We're working
154157
to make it easier to contribute code. If you'd like to work on something
155158
precise let us know.
156159

157-
todoici
158-
159-
160-
161-
162-
163-
164-
We've decided to open the core of the product and have a permissive license
165-
with the MIT license.
166-
167160

168161
## Open source, sponsors, paid SaaS
169162

@@ -184,7 +177,7 @@ StaticBackend. A tweet, a blog post, any visibility is helpful and I (Dominic)
184177
personally thanks you for this.
185178

186179
I've failed at getting any kind of traction with StaticBackend on its closed
187-
source form. I think developer tool like these need to be open source.
180+
source form. I think developer tools like this need to be open source.
188181

189182
I believe in the product, it solves a pain I have for so long, but I'm hoping
190183
others will also get value out of it and will be excited about the project.

0 commit comments

Comments
 (0)