Update docs [skip ci]

next
Sayan Nandan 3 years ago
parent 1bde8b197d
commit 31d5af91a2

@ -2,13 +2,11 @@
All changes in this project will be noted in this file.
<details>
<summary><b>Unreleased</b></summary>
**Unreleased**
* Snapshotting failure will now poison the database (customizable through CLI options or the configuration file)
[see [#160](https://github.com/skytable/skytable/pull/160)]
</details>
* Added file-locking on Solaris [see [#162](https://github.com/skytable/skytable/pull/162)]
## Version 0.6.0 [2021-05-27]

@ -48,7 +48,12 @@ Each project has its own jargon — and so do we!
### Branches
The `next` branch is the _kind of_ stable branch which contains the latest changes. However, for most purposes, you should always download sources from the tags. Usually, when a feature is worked on, the work will be done on a separate branch, and then it will be merged into next.
The `next` branch is the _kind of_ stable branch which contains the latest changes. However, for most purposes, you should always download sources from the tags.
Pushes are made directly
to next if they don't change things significantly; for example, changes in documentation comments and general optimizations. If
however the changes are huge, then they must be created on a separate branch, a pull request opened, the CI suite run and
finally merged into next.
## Steps
@ -61,6 +66,11 @@ The `next` branch is the _kind of_ stable branch which contains the latest chang
## Testing locally
1. Install rust (stable)
2. Run `cargo build --verbose && cargo test --verbose`
3. That's it!
1. Install the latest Rust toolchain (stable)
2. Install a C Compiler, Make, Perl and the libssl-dev package on platforms where they are required
3. First build the database server by running: `cargo build --verbose`
4. Now start the database server in the background
5. Now run `cargo test --verbose -- --test-threads=1`.
**Note:** Make sure that run the tests in a single-threaded way, else you'll find that a lot of tests fail. This is because several of the tests use the same keys
6. That's it!

@ -4,7 +4,7 @@
<h1>Skytable</h1><h3>The next-generation NoSQL database</h3>
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/skybasedb/skybase/Test%20(push)) ![Development](https://img.shields.io/badge/development-regular-32CD32?style=flat-square) ![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/skybasedb/skybase?include_prereleases&sort=semver&style=flat-square)
[![Docs](https://img.shields.io/badge/readthedocs-here-blueviolet?style=flat-square)](https://skytable.github.io/docs) [![Contribute Now](https://img.shields.io/badge/%F0%9F%8C%9Fcontribute-now-a94064)](https://ohsayan.github.io/skythanks)
[![Docs](https://img.shields.io/badge/readthedocs-here-blueviolet?style=flat-square)](https://skytable.github.io/docs) [![Contribute Now](https://img.shields.io/badge/%F0%9F%8C%9Fcontribute-now-a94064)](https://ohsayan.github.io/skythanks) [![Discord](https://img.shields.io/badge/talk-on%20discord-7289DA?logo=discord&style=flat-square")](https://discord.gg/QptWFdx)
</div>
</html>
@ -23,12 +23,12 @@ Skytable is curently under development, but can be used as a **performant**, **s
4. First run `sdb` to start the database server and then run `skysh` to start the interactive shell
5. Run commands like: `SET foo bar` , `GET bar` , `UPDATE cat mitten` or `DEL proprietary` 🤪 on `skysh` !
You can learn more about installation [here](https://skytable.github.io/docs/getting-started/)
You can learn more about installation [here](https://docs.skytable.io/getting-started/)
## Features
* **Insanely fast**: Scale to millions of queries per second per node
* **Key/value store**: `GET` , `SET` , `UPDATE` and [all that stuff](https://skytable.github.io/docs/actions/overview)
* **Key/value store**: `GET` , `SET` , `UPDATE` and [all that stuff](https://docs.skytable.io/actions-overview)
* **Snapshots**: Automated (and tunable) snapshots for stress-free backups
* **Secure**: Secure connections are built into Skytable with SSL/TLS
* **Multithreaded**: Designed to exploit all CPU cores

Loading…
Cancel
Save