Skip to content

Commit a69d3ab

Browse files
yukibtcyukibtc
committed
Follow up 6
Signed-off-by: Yuki Kishimoto <yukikishimoto@protonmail.com>
1 parent 4df0cd1 commit a69d3ab

3 files changed

Lines changed: 90 additions & 127 deletions

File tree

‎docs/intro.md‎

Lines changed: 1 addition & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -2,46 +2,5 @@
22
sidebar_position: 1
33
---
44

5-
# Tutorial Intro
5+
# Introduction
66

7-
Let's discover **Docusaurus in less than 5 minutes**.
8-
9-
## Getting Started
10-
11-
Get started by **creating a new site**.
12-
13-
Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
14-
15-
### What you'll need
16-
17-
- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
18-
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
19-
20-
## Generate a new site
21-
22-
Generate a new Docusaurus site using the **classic template**.
23-
24-
The classic template will automatically be added to your project after you run the command:
25-
26-
```bash
27-
npm init docusaurus@latest my-website classic
28-
```
29-
30-
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
31-
32-
The command also installs all necessary dependencies you need to run Docusaurus.
33-
34-
## Start your site
35-
36-
Run the development server:
37-
38-
```bash
39-
cd my-website
40-
npm run start
41-
```
42-
43-
The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
44-
45-
The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
46-
47-
Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.

‎docs/sdk/1-getting-started/1-install.mdx‎

Lines changed: 88 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -50,25 +50,6 @@ import LanguageTabs from '@site/src/components/LanguageTabs';
5050
from nostr_sdk import *
5151
```
5252

53-
### Requirements and supported platforms
54-
55-
Requires Python 3.9 or above.
56-
57-
The following OS and architectures are supported:
58-
59-
| OS | x86_64 | aarch64 | armv7 | i686 | riscv64 |
60-
|---------------|--------|---------|-------|------|---------|
61-
| Android | ❌ | ❌ | ❌ | ❌ | ❌ |
62-
| Linux (GLIBC) | ✅ | ✅ | ✅ | ✅ | ✅* |
63-
| Linux (MUSL) | ✅ | ✅ | ✅ | ✅ | ✅* |
64-
| FreeBSD | ✅* | ❌ | ❌ | ❌ | ❌ |
65-
| macOS | ✅ | ✅ | ❌ | ❌ | ❌ |
66-
| Windows | ✅ | ✅ | ❌ | ✅ | ❌ |
67-
68-
Are you interested in other platforms? Open an issue [here](https://github.com/rust-nostr/nostr-sdk-ffi).
69-
70-
<small>* PyPI currently doesn't allow uploading riscv64 wheels</small>
71-
7253
### Known issues
7354

7455
#### No running event loop
@@ -86,54 +67,29 @@ import LanguageTabs from '@site/src/components/LanguageTabs';
8667
<TabItem value="kotlin">
8768
Add the following library to your Gradle dependencies:
8869

89-
### Android
90-
9170
```kotlin
9271
repositories {
9372
mavenCentral()
9473
}
9574

9675
dependencies {
76+
// Android
9777
implementation("org.rust-nostr:nostr-sdk:0.43.0")
98-
}
99-
```
100-
101-
### JVM
102-
103-
```kotlin
104-
repositories {
105-
mavenCentral()
106-
}
10778

108-
dependencies {
79+
// JVM
10980
implementation("org.rust-nostr:nostr-sdk-jvm:0.43.0")
81+
82+
// Kotlin Multiplatform
83+
implementation("org.rust-nostr:nostr-sdk-kmp:0.43.0")
11084
}
11185
```
11286

113-
### Import the library
114-
11587
Import the library in your code:
11688

11789
```kotlin
11890
import rust.nostr.sdk.*
11991
```
12092

121-
### Supported platforms
122-
123-
The following OS and architectures are supported:
124-
125-
| OS | x86_64 | aarch64 | armv7 | i686 | riscv64 | Package |
126-
|---------------|--------|---------|-------|------|---------|-------------------------------------|
127-
| Android | ✅ | ✅ | ✅ | ✅ | ❌ | `nostr-sdk` and `nostr-sdk-kmp` |
128-
| iOS | ✅ | ✅ | ❌ | ❌ | ❌ | `nostr-sdk-kmp` |
129-
| Linux (GLIBC) | ✅ | ✅ | ✅ | ✅ | ✅ | `nostr-sdk-jvm` and `nostr-sdk-kmp` |
130-
| Linux (MUSL) | ✅ | ✅ | ✅ | ✅ | ✅ | `nostr-sdk-jvm` and `nostr-sdk-kmp` |
131-
| FreeBSD | ✅ | ❌ | ❌ | ❌ | ❌ | `nostr-sdk-jvm` and `nostr-sdk-kmp` |
132-
| macOS | ✅ | ✅ | ❌ | ❌ | ❌ | `nostr-sdk-jvm` and `nostr-sdk-kmp` |
133-
| Windows | ✅ | ✅ | ❌ | ✅ | ❌ | `nostr-sdk-jvm` and `nostr-sdk-kmp` |
134-
135-
Are you interested in other platforms? Open an issue [here](https://github.com/rust-nostr/nostr-sdk-ffi).
136-
13793
### Known issues
13894

13995
#### JNA dependency
@@ -181,22 +137,6 @@ import LanguageTabs from '@site/src/components/LanguageTabs';
181137
``` swift
182138
.package(url: "https://github.com/rust-nostr/nostr-sdk-swift.git", from: "0.43.0"),
183139
```
184-
185-
### Supported platforms
186-
187-
The following OS and architectures are supported:
188-
189-
| OS | x86_64 | aarch64 | armv7 | i686 |
190-
|------------------|--------|---------|-------|------|
191-
| iOS (>=14.0) | ❌ | ✅ | ❌ | ❌ |
192-
| iOS Simulator | ✅ | ✅ | ❌ | ❌ |
193-
| Mac Catalyst | ✅ | ✅ | ❌ | ❌ |
194-
| macOS (>=12.0) | ✅ | ✅ | ❌ | ❌ |
195-
| visionOS (>=1.0) | ❌ | ❌ | ❌ | ❌ |
196-
| watchOS | ❌ | ❌ | ❌ | ❌ |
197-
| tvOS | ❌ | ❌ | ❌ | ❌ |
198-
199-
Are you interested in other platforms? Open an issue [here](https://github.com/rust-nostr/nostr-sdk-ffi).
200140
</TabItem>
201141

202142
<TabItem value="csharp">
@@ -205,24 +145,6 @@ import LanguageTabs from '@site/src/components/LanguageTabs';
205145
```bash
206146
dotnet add package Nostr.Sdk --version 0.43.0
207147
```
208-
209-
### Requirements and supported platforms
210-
211-
Requires .NET 6.0 or above.
212-
213-
The following OS and architectures are supported:
214-
215-
| OS | x86_64 | aarch64 | armv7 | i686 | riscv64 |
216-
|---------------|--------|---------|-------|------|---------|
217-
| Android | ✅ | ✅ | ✅ | ✅ | ❌ |
218-
| iOS | ✅ | ✅ | ❌ | ❌ | ❌ |
219-
| Linux (GLIBC) | ✅ | ✅ | ✅ | ✅ | ✅ |
220-
| Linux (MUSL) | ✅ | ✅ | ✅ | ✅ | ✅ |
221-
| FreeBSD | ✅ | ❌ | ❌ | ❌ | ❌ |
222-
| macOS | ✅ | ✅ | ❌ | ❌ | ❌ |
223-
| Windows | ✅ | ✅ | ❌ | ✅ | ❌ |
224-
225-
Are you interested in other platforms? Open an issue [here](https://github.com/rust-nostr/nostr-sdk-ffi).
226148
</TabItem>
227149

228150
<TabItem value="js">
@@ -277,3 +199,86 @@ import LanguageTabs from '@site/src/components/LanguageTabs';
277199
```
278200
</TabItem>
279201
</LanguageTabs>
202+
203+
## Requirements and supported platforms
204+
205+
<LanguageTabs>
206+
<TabItem value="rust">
207+
Requires **rustc 1.70.0** or above.
208+
</TabItem>
209+
210+
<TabItem value="python">
211+
Requires **Python 3.9** or above.
212+
213+
The following OS and architectures are supported:
214+
215+
| OS | x86_64 | aarch64 | armv7 | i686 | riscv64 |
216+
|---------------|--------|---------|-------|------|---------|
217+
| Android | ❌ | ❌ | ❌ | ❌ | ❌ |
218+
| Linux (GLIBC) | ✅ | ✅ | ✅ | ✅ | ✅* |
219+
| Linux (MUSL) | ✅ | ✅ | ✅ | ✅ | ✅* |
220+
| FreeBSD | ✅* | ❌ | ❌ | ❌ | ❌ |
221+
| macOS | ✅ | ✅ | ❌ | ❌ | ❌ |
222+
| Windows | ✅ | ✅ | ❌ | ✅ | ❌ |
223+
224+
Are you interested in other platforms? Open an issue [here](https://github.com/rust-nostr/nostr-sdk-ffi).
225+
226+
<small>* PyPI currently doesn't allow uploading riscv64 wheels</small>
227+
</TabItem>
228+
229+
<TabItem value="kotlin">
230+
The following OS and architectures are supported:
231+
232+
| OS | x86_64 | aarch64 | armv7 | i686 | riscv64 | Package |
233+
|---------------|--------|---------|-------|------|---------|-------------------------------------|
234+
| Android | ✅ | ✅ | ✅ | ✅ | ❌ | `nostr-sdk` and `nostr-sdk-kmp` |
235+
| iOS | ✅ | ✅ | ❌ | ❌ | ❌ | `nostr-sdk-kmp` |
236+
| Linux (GLIBC) | ✅ | ✅ | ✅ | ✅ | ✅ | `nostr-sdk-jvm` and `nostr-sdk-kmp` |
237+
| Linux (MUSL) | ✅ | ✅ | ✅ | ✅ | ✅ | `nostr-sdk-jvm` and `nostr-sdk-kmp` |
238+
| FreeBSD | ✅ | ❌ | ❌ | ❌ | ❌ | `nostr-sdk-jvm` and `nostr-sdk-kmp` |
239+
| macOS | ✅ | ✅ | ❌ | ❌ | ❌ | `nostr-sdk-jvm` and `nostr-sdk-kmp` |
240+
| Windows | ✅ | ✅ | ❌ | ✅ | ❌ | `nostr-sdk-jvm` and `nostr-sdk-kmp` |
241+
242+
Are you interested in other platforms? Open an issue [here](https://github.com/rust-nostr/nostr-sdk-ffi).
243+
</TabItem>
244+
245+
<TabItem value="swift">
246+
The following OS and architectures are supported:
247+
248+
| OS | x86_64 | aarch64 | armv7 | i686 |
249+
|------------------|--------|---------|-------|------|
250+
| iOS (>=14.0) | ❌ | ✅ | ❌ | ❌ |
251+
| iOS Simulator | ✅ | ✅ | ❌ | ❌ |
252+
| Mac Catalyst | ✅ | ✅ | ❌ | ❌ |
253+
| macOS (>=12.0) | ✅ | ✅ | ❌ | ❌ |
254+
| visionOS (>=1.0) | ❌ | ❌ | ❌ | ❌ |
255+
| watchOS | ❌ | ❌ | ❌ | ❌ |
256+
| tvOS | ❌ | ❌ | ❌ | ❌ |
257+
258+
Are you interested in other platforms? Open an issue [here](https://github.com/rust-nostr/nostr-sdk-ffi).
259+
</TabItem>
260+
261+
<TabItem value="csharp">
262+
Requires **.NET 6.0** or above.
263+
264+
The following OS and architectures are supported:
265+
266+
| OS | x86_64 | aarch64 | armv7 | i686 | riscv64 |
267+
|---------------|--------|---------|-------|------|---------|
268+
| Android | ✅ | ✅ | ✅ | ✅ | ❌ |
269+
| iOS | ✅ | ✅ | ❌ | ❌ | ❌ |
270+
| Linux (GLIBC) | ✅ | ✅ | ✅ | ✅ | ✅ |
271+
| Linux (MUSL) | ✅ | ✅ | ✅ | ✅ | ✅ |
272+
| FreeBSD | ✅ | ❌ | ❌ | ❌ | ❌ |
273+
| macOS | ✅ | ✅ | ❌ | ❌ | ❌ |
274+
| Windows | ✅ | ✅ | ❌ | ✅ | ❌ |
275+
276+
Are you interested in other platforms? Open an issue [here](https://github.com/rust-nostr/nostr-sdk-ffi).
277+
</TabItem>
278+
279+
<TabItem value="js">
280+
Requires **Node.js 16.0.0** or above.
281+
282+
Supports both Node.js and WebAssembly.
283+
</TabItem>
284+
</LanguageTabs>

‎docusaurus.config.ts‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,7 @@ const config: Config = {
4242
{
4343
docs: {
4444
sidebarPath: './sidebars.ts',
45-
editUrl:
46-
'https://github.com/rust-nostr/book',
45+
editUrl: 'https://github.com/rust-nostr/book',
4746
},
4847
blog: {
4948
showReadingTime: true,

0 commit comments

Comments
 (0)