Remove docs website in favor of Deno doc (#141)

docs/contributing.md → CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contribute to SQLite for Deno
 
-?> This is a draft.
+> Note: this is a draft
 
 Thank you for considering to contribute to the SQLite for Deno module! Below are
 a few guidelines on how to contribute.
@@ -36,12 +36,10 @@ For testing purposes, Deno standard library modules may be used.
 ## Documentation
 
 Any user-facing interfaces should be documented. To document such interfaces,
-include a **documenting comment**, which must be formatted as follows:
+include a **JSDoc comment**, which should be formatted as follows:
 
 ```javascript
 /**
- * ClassName.functionName
- *
  * A short but complete description, formatted
  * as markdown.
  */
@@ -50,39 +48,36 @@ functionName(arg1, arg2) {
 }
 ```
 
-Comments with this format will be automatically parsed by a CI script and added
-to the documentation at [`api.md`](./api.md). The first line of the comment
-identifies the class and function, which helps the script format the comment
-correctly.
+Comments with this format will be automatically parsed by `deno doc`.
 
 These comments should not include examples unless they are essential to
-illustrating an important point. Examples (cook-book style code snippets) should
-be added to [`examples.md`](./examples.md).
+illustrating an important point.
 
 ## Tests and Benchmarks
 
 Any important functionality should be tested. Tests are in the `test.ts` file.
-Changes will not be merged unless all tests are passed.
+Changes will not be merged unless all tests pass.
 
 Benchmarks are in the `bench.ts` file.
 
-# Technical Direction
+## Technical Direction
 
-The goal of this module is to provide a simple and predictable interface to
+The goal of this module is to provide a **simple and predictable** interface to
 SQLite. The interface should feel like a JavaScript library, but also
 immediately make sense to someone who knows the SQLite C/C++ interface. Features
 and interfaces should generally be orthogonal.
 
 This is a low-level library, which provides access to running SQL queries and
-retriving the results of these queries. This library will only wrap SQLite C api
-functions, but never try to provide a higher level interface to the database
+retrieving the results of these queries. This library will only wrap SQLite C
+API functions, but never try to provide a higher level interface to the database
 than plain SQL. It is meant to serve as a building block for constructing higher
 level interfaces, or for people who need an easy way to execute SQL queries on
 their SQLite database.
 
 The library should be easy to use and behave as any regular JavaScript library
 would in Deno. This means, it should only need the required permissions (e.g. if
-only in-memory databases are used, no permissions should be necessary).
+only in-memory databases are used, no permissions should be necessary. If a
+database is opened in read-only mode, `--allow-read` should be sufficient).
 
 ## License
 

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2019 Tilman Roeder and Contributors
+Copyright (c) 2019 - 2021 Tilman Roeder and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,24 +1,23 @@
 # Deno SQLite Module
 
 [![test status](https://github.com/dyedgreen/deno-sqlite/workflows/tests/badge.svg?branch=master)](https://github.com/dyedgreen/deno-sqlite/actions)
-[![docs status](https://github.com/dyedgreen/deno-sqlite/workflows/docs/badge.svg?branch=master)][docs-web]
-[![deno doc](https://doc.deno.land/badge.svg)][docs-deno]
+[![deno doc](https://doc.deno.land/badge.svg)](https://deno.land/x/sqlite)
 
-[docs-deno]: https://deno.land/x/sqlite
-[docs-web]: https://dyedgreen.github.io/deno-sqlite/
-
-This is an SQLite module for JavaScript. The wrapper is targeted at
-[Deno](https://deno.land) and uses a version of SQLite3 compiled to WebAssembly
-(WASM). This module focuses on ease of use and performance.
+This is an SQLite module for JavaScript and TypeScript. The wrapper is targeted
+at [Deno](https://deno.land) and uses a version of SQLite3 compiled to
+WebAssembly (WASM). This module focuses on correctness, ease of use and
+performance.
 
 This module guarantees API compatibility according to
 [semantic versioning](https://semver.org). Please report any issues you
-encounter.
+encounter. Note that the `master` branch might contain new or breaking features.
+The versioning guarantee applies only to
+[tagged releases](https://github.com/dyedgreen/deno-sqlite/releases).
 
 ## Documentation
 
-Documentation is available as a [website][docs-web], on [Deno Docs][docs-deno],
-or in the [`docs`](./docs/README.md) folder.
+Documentation is available [Deno Docs](https://deno.land/x/sqlite). There is
+also a list of examples in the [`examples`](./examples) folder.
 
 ## Example
 
@@ -27,9 +26,12 @@ import { DB } from "https://deno.land/x/sqlite/mod.ts";
 
 // Open a database
 const db = new DB("test.db");
-db.query(
-  "CREATE TABLE IF NOT EXISTS people (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT)",
-);
+db.query(`
+  CREATE TABLE IF NOT EXISTS people (
+    id INTEGER PRIMARY KEY AUTOINCREMENT,
+    name TEXT
+  )
+`);
 
 const names = ["Peter Parker", "Clark Kent", "Bruce Wayne"];
 
@@ -51,8 +53,7 @@ db.close();
 
 ### TL;DR
 
-If you want something that just works (and is fast) in the majority of cases,
-use this library.
+If you want something that just works (and is fast), use this library.
 
 Depending on your specific needs, there is also
 [deno_sqlite_plugin](https://github.com/crabmusket/deno_sqlite_plugin), however
@@ -77,11 +78,12 @@ this module seems to no longer be actively maintained.
 
 ## Users
 
-_(In alphabetical order)_
-
 - [cotton](https://github.com/rahmanfadhil/cotton)
 - [deno-nessie](https://github.com/halvardssm/deno-nessie)
 - [denodb](https://github.com/eveningkid/denodb)
 - [denolib/typeorm](https://github.com/denolib/typeorm)
 - [dexecutor](https://github.com/denjucks/dexecutor)
 - [small-orm-sqlite](https://github.com/enimatek-nl/small-orm-sqlite)
+
+_(listed in alphabetical order, please submit a PR if you are using this library
+and are not included)_