Skip to content

Commit 0cadfc3

Browse files
authored
Update README.md
1 parent 625e31c commit 0cadfc3

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ SELECT
7878
required, description
7979
FROM user_form;
8080

81-
INSERT INTO user (first_name, last_name, birth_date)
81+
INSERT INTO user
8282
SELECT $first_name, $last_name, $birth_date
8383
WHERE $first_name IS NOT NULL;
8484
```
@@ -93,8 +93,7 @@ WHERE $first_name IS NOT NULL;
9393

9494
```sql
9595
select 'tab' as component, true as center;
96-
select 'Show all cards' as title,
97-
'?' as link,
96+
select 'Show all cards' as title, '?' as link,
9897
$tab is null as active;
9998
select
10099
format('Show %s cards', color) as title,
@@ -110,6 +109,10 @@ select
110109
image_url as top_image, link
111110
from tab_example_cards
112111
where $tab is null or $tab = color;
112+
113+
select
114+
'text' as component,
115+
sqlpage.read_file_as_text('file.md') as contents_md
113116
```
114117

115118
<td>
@@ -122,7 +125,7 @@ where $tab is null or $tab = color;
122125

123126
## Supported databases
124127

125-
- [sqlite](https://www.sqlite.org/index.html)
128+
- [SQLite](https://www.sqlite.org/index.html)
126129
- [PostgreSQL](https://www.postgresql.org/), and other compatible databases such as *YugabyteDB*, *CockroachDB* and *Aurora*.
127130
- [MySQL](https://www.mysql.com/), and other compatible databases such as *MariaDB* and *TiDB*.
128131
- [Microsoft SQL Server](https://www.microsoft.com/en-us/sql-server), and all compatible databases and providers such as *Azure SQL* and *Amazon RDS*.
@@ -146,14 +149,14 @@ to the user's browser.
146149

147150
[Read the official *get started* guide on SQLPage's website](https://sql.ophir.dev/get_started.sql).
148151

149-
### Using native binaries
152+
### Using executables
150153

151154
The easiest way to get started is to download the latest release from the
152155
[releases page](https://github.com/lovasoa/SQLpage/releases).
153156

154157
- Download the binary that corresponds to your operating system (linux, macos, or windows).
155158
- Uncompress it: `tar -xzf sqlpage-*.tgz`
156-
- Run it in a terminal: `./sqlpage.bin`
159+
- Run it: `./sqlpage.bin`
157160

158161
### With docker
159162

@@ -193,8 +196,10 @@ An alternative for Mac OS users is to use [SQLPage's homebrew package](https://f
193196
- [Image gallery](./examples/image%20gallery%20with%20user%20uploads/): An image gallery where users can log in and upload images. Illustrates the implementation of a user authentication system using session cookies, and the handling of file uploads.
194197
- [User Management](./examples/user-authentication/): An authentication demo with user registration, log in, log out, and confidential pages. Uses PostgreSQL.
195198
- [Making a JSON API and integrating React components in the frontend](./examples/using%20react%20and%20other%20custom%20scripts%20and%20styles/): Shows how to integrate a react component in a SQLPage website, and how to easily build a REST API with SQLPage.
199+
- [Handling file uploads](./examples/image%20gallery%20with%20user%20uploads): An image gallery where authenticated users can publish new images via an upload form.
200+
- [Bulk data import from CSV files](./examples/official-site/examples/handle_csv_upload.sql) : A simple form letting users import CSV files to fill a database table.
196201
197-
You can try all the examples online using [SQLPage's online demo on replit](https://replit.com/@pimaj62145/SQLPage).
202+
You can try all the examples online without installing anything on your computer using [SQLPage's online demo on replit](https://replit.com/@pimaj62145/SQLPage).
198203

199204
## Configuration
200205

@@ -206,6 +211,15 @@ For more information, read [`configuration.md`](./configuration.md).
206211
Additionally, custom components can be created by placing [`.handlebars`](https://handlebarsjs.com/guide/)
207212
files in `sqlpage/templates`. [Example](./sqlpage/templates/card.handlebars).
208213

214+
### HTTPS
215+
216+
SQLPage supports HTTP/2 and HTTPS natively and transparently.
217+
Just set `SQLPAGE_HTTPS_DOMAIN=example.com`, and SQLPage
218+
will automatically request a trusted certificate and
219+
start encrypting all your user's traffic with it.
220+
No tedious manual configuration for you,
221+
and no annoying "Connection is Not Secure" messages for your users !
222+
209223
## Serverless
210224
211225
You can run SQLpage [serverless](https://en.wikipedia.org/wiki/Serverless_computing)

0 commit comments

Comments
 (0)