Skip to content

Commit

Permalink
Reorganize some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@ohsayan
ohsayan committed Dec 30, 2023
1 parent 2b3e045 commit 3b3aec6
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 24 deletions.
26 changes: 14 additions & 12 deletions docs/13.libraries.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@ title: Client drivers

## Official drivers

We officially maintain the following drivers:
The drivers that are officially maintained can be expected to be feature complete and stable. We currently support the following drivers:

- [Rust driver](https://github.com/skytable/client-rust) [Apache-2.0] - Always up to date and is used by the core project itself
- [NodeJS driver **(WIP)**](https://github.com/skytable/client-nodejs) [Apache-2.0]: Currently a work in progress to try and build an idiomatic NodeJS driver
| Language/Framework | Source Code | Status |
| ------------------------------ | --------------------------------------------------- | -------- |
| Rust | [GitHub](https://github.com/skytable/client-rust) | Stable ✅ |
| NodeJS (JavaScript/TypeScript) | [GitHub](https://github.com/skytable/client-nodejs) | Beta 🏗 |

:::info More lanugages
The team is always looking to support more languages and we wish we could ship more drivers. But due to limited
Expand All @@ -22,12 +24,12 @@ List of community powered drivers (sorted alphabetically):

| Language/Framework | Client source code | Upstreamed | License | Remarks |
| -------------------------------- | ------------------------------------------------------------- | ---------- | ---------- | --------------------------------------------------------------------------------- |
| **C#/.NET** | | ❗ | | |
| | [C# driver](https://github.com/martinmolin/skytable-dotnet) | ❗ | Apache-2.0 | Available on [NuGet](https://www.nuget.org/packages/Skytable.Client) |
| **Go** | | ❗ | | |
| | [Go driver](https://github.com/No3371/go-skytable) | ❗ | Apache-2.0 | Written from scratch |
| | [Go driver](https://github.com/satvik007/skytable-go) | ❗ | Apache-2.0 | Easy for migration from go-redis |
| **JavaScript/TypeScript (Node)** | | ❗ | | |
| | [NodeJS Driver](https://github.com/zhangyuannie/skytable.js) | ❗ | Apache-2.0 | Available on [npm](https://www.npmjs.com/package/skytable.js) |
| **PHP** | | ❗ | | |
| | [PHP client driver](https://github.com/hkulekci/skytable-php) | ❗ | MIT | Can be found on [Packagist](https://packagist.org/packages/hkulekci/skytable-php) |
| **C#/.NET** | | ❗ | | |
| | [C# driver](https://github.com/martinmolin/skytable-dotnet) | ❗ | Apache-2.0 | Available on [NuGet](https://www.nuget.org/packages/Skytable.Client) |
| **Go** | | ❗ | | |
| | [Go driver](https://github.com/No3371/go-skytable) | ❗ | Apache-2.0 | Written from scratch |
| | [Go driver](https://github.com/satvik007/skytable-go) | ❗ | Apache-2.0 | Easy for migration from go-redis |
| **JavaScript/TypeScript (Node)** | | ❗ | | |
| | [NodeJS Driver](https://github.com/zhangyuannie/skytable.js) | ❗ | Apache-2.0 | Available on [npm](https://www.npmjs.com/package/skytable.js) |
| **PHP** | | ❗ | | |
| | [PHP client driver](https://github.com/hkulekci/skytable-php) | ❗ | MIT | Can be found on [Packagist](https://packagist.org/packages/hkulekci/skytable-php) |
14 changes: 7 additions & 7 deletions docs/2.installation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,6 @@ Getting started with Skytable involves choosing a mode of installation, download
## Native binaries

:::info
Your operating system might sometimes not let you run binaries directly. On Unix based systems, you'll need to run: `chmod +x skyd skysh sky-bench`.

And on Windows systems you might need to right-click on the binaries and click on "unblock"
:::

To use native binaries you need to download a bundle which is simply a ZIP file with all the necessary binaries that you'll ever need to develop on and deploy Skytable.

1. **First download the latest bundle** for your platform. You can find [download links on the releases page](https://github.com/skytable/skytable/releases).
Expand All @@ -39,6 +33,12 @@ To use native binaries you need to download a bundle which is simply a ZIP file

The server starts up at `localhost:2003` and is ready to run queries.

:::info
Your operating system might sometimes not let you run binaries directly. On Unix based systems, you'll need to run: `chmod +x skyd skysh sky-bench`.
And on Windows systems you might need to right-click on the binaries and click on "unblock"
:::
## Debian package
Find the correct `*.deb` file [from the releases page](https://github.com/skytable/skytable/releases). Now simply run:
Expand Down Expand Up @@ -71,7 +71,7 @@ The package will:
```
:::tip
The password for the Skytable instance on the Docker container is auto-generated Run `docker logs -f skydb` and you'll see a log
The password for the Skytable instance on the Docker container is auto-generated. Run `docker logs -f skydb` and you'll see a log
message with the generated password.
:::

Expand Down
9 changes: 4 additions & 5 deletions docs/resources/1.overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ title: Resources

## Community and chat

The community platform that we use the most is Discord. Here is a link to [our Discord Community](https://discord.gg/QptWFdx).
Both our developers and users hang out almost all day around here, so you can expect to get your query resolved fairly quickly.
- [**Discord Community**](https://discord.gg/QptWFdx): The community platform that we use the most is Discord. Both our developers and users hang out almost all day around here, so you can expect to get your query resolved fairly quickly.
- [**GitHub Discussions**](https://github.com/skytable/skytable/discussions): If you prefer a more forum like discussion, then please make use of GitHub Discussions. We're fairly responsive here as well.

## News

- [**Skytable Blog**](https://blog.skytable.io): This is where you'll hear from us about major updates such as new releases, changes in maintenance and such
- [**Skytable Blog**](https://skytable.io/blog): This is where you'll hear from us about major updates such as new releases, changes in maintenance and such
- [**X/Twitter**](https://twitter.com/skytabledb): On X (formerly Twitter), we post live updates as we work on new features. If there's a quick update or milestone, you'll be the first to know here
- [**E-mail**](https://cdn.forms-content.sg-form.com/e4a9719e-d94e-11eb-89d2-9232e6ded8b5): While we haven't ever sent out any e-mails, if you're keen on signing up for updates in the (near) future, it's a good idea to subscribe to this list. Just like we said, we haven't yet sent out anything! We're building software, not sending you fancy email!

Expand All @@ -19,7 +19,6 @@ Both our developers and users hang out almost all day around here, so you can ex
- [**Jotsy (rust)**](https://github.com/ohsayan/jotsy): Jotsy is a very small "blog" implementation that is written in Rust with Skytable and the Axum framework. If you're building something in Rust, do check it out
- [**Client repo (rust)**](https://github.com/skytable/client-rust): While this is in Rust, you might find the examples useful regardless of which language you're developing your application in


## Client drivers

Please head over to the [libraries](libraries) page.
Please head over to the [libraries](/libraries) page.

0 comments on commit 3b3aec6

Please sign in to comment.