Skip to content

Commit 0c0cae5

Browse files
committed
moved README file
1 parent 04fe761 commit 0c0cae5

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/README.md README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The fastest and simplest library for SQLite3 in Node.js.
1515
|better-sqlite3|1x|1x|1x|1x|1x|
1616
|[sqlite](https://www.npmjs.com/package/sqlite) and [sqlite3](https://www.npmjs.com/package/sqlite3)|10.4x slower|2.2x slower|18.8x slower|2.8x slower|12.9x slower|
1717

18-
> You can verify these results by [running the benchmark yourself](./benchmark.md).
18+
> You can verify these results by [running the benchmark yourself](./docs/benchmark.md).
1919
> *Both [npm/sqlite](https://www.npmjs.com/package/sqlite) and [npm/sqlite3](https://www.npmjs.com/package/sqlite3) have nearly identical performance because they both use the [same engine](https://github.com/mapbox/node-sqlite3).*
2020
2121
## Installation
@@ -24,7 +24,7 @@ The fastest and simplest library for SQLite3 in Node.js.
2424
npm install --save better-sqlite3
2525
```
2626

27-
> If you have trouble installing, check the [troubleshooting guide](./troubleshooting.md).
27+
> If you have trouble installing, check the [troubleshooting guide](./docs/troubleshooting.md).
2828
2929
## Usage
3030

@@ -46,7 +46,7 @@ console.log(row.firstName, row.lastName, row.email);
4646

4747
In most cases, if you're attempting something that cannot be reasonably accomplished with `better-sqlite3`, it probably cannot be reasonably accomplished with SQLite3 in general. For example, if you're executing queries that take one second to complete, and you expect to have many concurrent users executing those queries, no amount of asynchronicity will save you from SQLite3's serialized nature. Fortunately, SQLite3 is very *very* fast. With proper indexing, we've been able to achieve upward of 2000 queries per second with 5-way-joins in a 60 GB database, where each query was handling 5–50 kilobytes of real data.
4848

49-
If you have a performance problem, the most likely causes are inefficient queries, improper indexing, or a lack of [WAL mode](./performance.md)—not `better-sqlite3` itself. However, there are some cases where `better-sqlite3` could be inappropriate:
49+
If you have a performance problem, the most likely causes are inefficient queries, improper indexing, or a lack of [WAL mode](./docs/performance.md)—not `better-sqlite3` itself. However, there are some cases where `better-sqlite3` could be inappropriate:
5050

5151
- If you expect a high volume of concurrent reads each returning hundreds of megabytes of data (i.e., videos)
5252
- If you expect a high volume of concurrent writes (i.e., a social media site)
@@ -56,11 +56,11 @@ For these situations, you should probably use a full-fledged RDBMS such as [Post
5656

5757
# Documentation
5858

59-
- [API documentation](./api.md)
60-
- [Performance](./performance.md) (also see [benchmark results](./benchmark.md))
61-
- [64-bit integer support](./integer.md)
62-
- [SQLite3 compilation](./compilation.md)
59+
- [API documentation](./docs/api.md)
60+
- [Performance](./docs/performance.md) (also see [benchmark results](./docs/benchmark.md))
61+
- [64-bit integer support](./docs/integer.md)
62+
- [SQLite3 compilation](./docs/compilation.md)
6363

6464
# License
6565

66-
[MIT](../LICENSE)
66+
[MIT](./LICENSE)

0 commit comments

Comments
 (0)