updated README and added pkg to Makefile

Author: dstpierre

.gitignore

@@ -2,6 +2,8 @@
 mongodata/
 cmd/staticbackend
 
+dist/
+
 # Binaries for programs and plugins
 *.exe
 *.exe~

Makefile

@@ -12,4 +12,17 @@ deploy:
 	scp staticbackend sb-poc:/home/dstpierre/sb
 
 test:
-	@JWT_SECRET=okdevmode go test --race --cover ./...
+	@JWT_SECRET=okdevmode go test --race --cover ./...
+
+pkg: build
+	@rm -rf dist/*
+	@echo "building linux binaries"
+	@CGO_ENABLED=0 GOARCH=amd64 GOOS=linux go build -o dist/binary-for-linux-64-bit
+	@CGO_ENABLED=0 GOARCH=386 GOOS=linux go build -o dist/binary-for-linux-32-bit
+	@echo "building mac binaries"
+	@CGO_ENABLED=0 GOARCH=amd64 GOOS=darwin go build -o dist/binary-for-mac-64-bit
+	@echo "building windows binaries"
+	@CGO_ENABLED=0 GOARCH=amd64 GOOS=windows go build -o dist/binary-for-windows-64-bit.exe
+	@CGO_ENABLED=0 GOARCH=386 GOOS=windows go build -o dist/binary-for-windows-32-bit.exe
+	@echo "compressing binaries"
+	@gzip dist/*

README.md

@@ -5,105 +5,186 @@
 # StaticBackend - simple backend for your apps
 
 [StaticBackend](https://staticbackend.com) is a simple backend that handles 
-user management, database, file storage, and real-time experiences via 
+user management, database, file storage, forms, and real-time experiences via 
 channel/topic-based communication for web and mobile applications.
 
 You can think of it as a lightweight Firebase replacement you may self-host. No 
-vendor lock-in, and your data stays in your control. You may contribute to the 
-product.
+vendor lock-in, and your data stays in your control.
 
-We've decided to open the core of the product and have a permissive license 
-with the MIT license.
+### Table of content
 
-We [provide a CLI](https://staticbackend.com/getting-started/) for local 
-development if you want to get things started without any infrastructure and 
-for prototyping. 
+* [What can you build](#what-can-you-build)
+* [How it works / dev workflow](#how-it-works-dev-workflow)
+* [Get started with the self-hosted version](#get-started-with-the-self-hosted-version)
+* [Documentation](#documentation)
+* [Librairies & CLI](#libraries-cli)
+* [Examples](#examples)
+* [Deploying in production](#deploying-in-production)
+* [Feedback & contributing](#feedback-contributing)
+* [Open source, sponsors, paid SaaS](#open-source-sponsors-paid-saas)
+* [Spread the words](#spread-the-words)
+
+
+## What can you build
+
+I built StaticBackend with the mindset of someone tired of writing the same code 
+over and over on the backend. If you're application needs one or all of 
+user management, database, file storage, real-time interactions, it should be 
+a good fit.
+
+I'm personally using it to build SaaS.
+
+## How it works / dev workflow
+
+The main idea is that StaticBackend is your backend API for your frontend apps.
+
+It needs to have access to MongoDB and Redis servers. Once you have your instance 
+running you create accounts for your applications.
+
+An account has its own database, file storage, etc.
+
+I think `app` might have been a better name instead of `account`. Naming things 
+is hard.
+
+A StaticBackend account(app) can have multiple user accounts and each user 
+accounts may have multiple users.
+
+From there each users can create database documents that are by default Read/Write 
+for the owner (the user) and Read for its parent account. You may customize 
+permission for each of your collection (see that later in the documentation).
+
+From here you have the basics building blocks to create a typical web 
+application. You have all your CRUD and data query operations cover, file 
+storage and websocket-like capabilities.
+
+We have a [JavaScript](https://www.npmjs.com/package/@staticbackend/js) to 
+get started quickly. We have also server-side libraries for Node and Go atm.
+
+Why would you need server-side libraries, was it not suppose to be a backend 
+for client-side application.
+
+Yes, but, there's always a but. Sometimes your application will need to 
+perform tasks on behalf of users or public user that do not have access to 
+perform CRUD from the client-side.
+
+Let's imagine we're building an invoicing app. Here's the major entities 
+we have for this examples:
+
+* A StaticBackend account (our app inside our SB instance)
+* An account with 2 users (this would be your customer)
+* An invoices collection (where your customer create invoice)
+* A clients collection (Your customer send invoice to their clients)
 
-### Run locally
+Now let's imagine our customer (our app user) sends an invoice to their Client.
 
-You'll need docker (or access to a MongoDB and Redis instances).
+Their client does not have any user account, but they need to see their invoice 
+when they click on the unique link on their email they received.
 
-1. Clone this repository
+This can be achieve via a backend function. Couple of ways:
 
-```shell
-$> git clone git@github.com/staticbackendhq/core.git
-```
+* The email the client received can be directly a unique URL pointing to a 
+function as a service hosted somewhere. (We will have functions soon).
+* Or it could be pointing to your client-side app and you perform a call to 
+a serverless function you're hosting somewhere.
 
-2. In a terminal start the docker services
+The function will be able to perform a Read operation using a special `Root Token`.
 
-```shell
-$> docker-compose up
-```
+This Root Token allow your system to do anything in the server-side.
 
-3. Create a file named `.env` with the following environment variables:
+I hope I did not lost the majority of people here ;)
 
-```
-APP_ENV=dev
-DATABASE_URL=localhost
-FROM_EMAIL=you@domain.com
-FROM_NAME=your-name
-JWT_SECRET=something-here
-AWS_ACCESS_KEY_ID=your-aws-key
-AWS_SECRET_ACCESS_KEY=your-aws-secret
-AWS_SECRET_KEY=your-aws-key
-AWS_SES_ENDPOINT=https://email.us-east-1.amazonaws.com
-```
+This is one example of your typical day-to-day workflow using StaticBackend.
 
-3. Compile and run the API server
+## Get started with the self-hosted version
 
-```shell
-$> make start
-```
+Please refer to this [guide here](https://staticbackend.com/getting-started/self-hosting/).
 
-### Usage
+## Documentation
 
-You have multiple options to use the backend:
+We're trying to have the best experience possible reading our documentation.
 
-* You may use our server-side client libraries (currently 
-[Go](https://github.com/staticbackendhq/backend-go) and [Node](https://github.com/staticbackendhq/backend-node))
-* From your client-side applications using our [JavaScript library](https://github.com/staticbackendhq/backend-js)
-* You may use your own HTTP client
+Please help us improve if you have any feedback.
 
-To start using the backend you'll need to create an account on your local 
-instance.
+**Documentation with example using our libraries or curl**:
 
-You'll need to [install our CLI](https://staticbackend.com/getting-started/) and 
-have it running in local mode so it will talk to your local backend instance.
+* [Introduction and authentication](https://staticbackend.com/docs/)
+* [User management](https://staticbackend.com/docs/users/)
+* [Database](https://staticbackend.com/docs/database/)
+* [Real-time communication](https://staticbackend.com/docs/websocket/)
+* [File storage](https://staticbackend.com/docs/storage/)
+* [Forms](https://staticbackend.com/docs/forms/)
 
-```shell
-$> backend account create you@domain.com
-```
+## Librairies & CLI
 
-Make sure you use a real domain and make sure you're all set sending email 
-via your AWS account.
+We [provide a CLI](https://staticbackend.com/getting-started/) for local 
+development if you want to get things started without any infrastructure and 
+for prototyping. 
+
+You can use the CLI to manage your database and form submission. This is the 
+only interface we currently have to interact with your database, other than via 
+code. There will be a web UI available before v1.0 is released.
+
+We have a page listing our 
+[client-side and server-side libraries](https://staticbackend.com/docs/libraries/).
+
+## Examples
 
-In `dev` mode emails are printed to the stdout so you will see the account 
-information for your new database account.
+If you'd like to see specifics examples please let us know via the 
+[Discussions](https://github.com/staticbackendhq/core/discussions) tab.
 
-Once you have those info you're ready to start calling the API from client-side 
-or server-side application.
+Here's the examples we have created so far:
 
-Refer to [our main documentation](https://staticbackend.com/docs/) for more 
-information.
+* [To-do list example](https://staticbackend.com/getting-started/)
+* [Realtime collaboration](https://staticbackend.com/blog/realtime-collaboration-example/)
 
-### Deploying in production
+## Deploying in production
 
 We've not written anything yet regarding deploying, but once you have the 
-`core` built into a binary and have access to MongoDB and Redis in production you 
+core` built into a binary and have access to MongoDB and Redis in production you 
 should be able to deploy it like any other Go server.
 
 We'll have documentation and an example soon for deploying to DigitalOcean.
 
-### Contributing
+## Feedback & contributing
+
+If you have any feedback (good or bad) we'd be more than happy to talk. Please 
+use the [Discussions](https://github.com/staticbackendhq/core/discussions) tab.
+
+Same for contributing. The easiest is to get in touch first. We're working 
+to make it easier to contribute code. If you'd like to work on something 
+precise let us know.
+
+todoici
+
+
+
+
+
+
+We've decided to open the core of the product and have a permissive license 
+with the MIT license.
+
+
+## Open source, sponsors, paid SaaS
+
+You may read here 
+[why we've decided to open source StaticBackend](https://staticbackend.com/blog/open-source-backend-as-a-service/).
+
+Hopefully we can start getting sponsorship so the open source version development 
+and future is secure.
+
+We're also offering paid subscription for a 
+[fully managed](https://staticbackend.com/blog/open-source-backend-as-a-service/) 
+version of SB.
 
-This is still pre-v1 and API _might_ change. All contributions highly appreciated, 
-please make sure to discuss before starting anything.
+## Spread the words
 
-### Roadmap
+It would means the world to us if you could help us spread the words about 
+StaticBackend. A tweet, a blog post, any visibility is helpful and I (Dominic) 
+personally thanks you for this.
 
-We've the following features in the pipeline:
+I've failed at getting any kind of traction with StaticBackend on its closed 
+source form. I think developer tool like these need to be open source.
 
-1. ~Serverless function would enable having some backend functions directly 
-runnable from the backend server.
-2. Message Queueing system (this is related to having custom function running first)
-3. Try to make StaticBackend as useful as possible aka listening to feedback
+I believe in the product, it solves a pain I have for so long, but I'm hoping 
+others will also get value out of it and will be excited about the project.