From d33c174e9056604af4b85adc2bf0f9d01b3b1fcd Mon Sep 17 00:00:00 2001
From: Hugo Delaunay
Date: Fri, 24 Nov 2023 00:27:25 +0100
Subject: [PATCH] chore(docs): Updated website, README and links !
---
docs/.gitignore | 2 +-
docs/components/Page/PageFooter.vue | 3 +-
docs/content/docs.md | 2 +-
docs/nuxt.config.ts | 6 ++
packages/bonsoir/README.md | 64 ++-----------------
packages/bonsoir/pubspec.yaml | 1 +
packages/bonsoir_android/pubspec.yaml | 1 +
packages/bonsoir_darwin/pubspec.yaml | 1 +
packages/bonsoir_linux/pubspec.yaml | 1 +
.../bonsoir_platform_interface/pubspec.yaml | 1 +
packages/bonsoir_windows/pubspec.yaml | 1 +
11 files changed, 20 insertions(+), 63 deletions(-)
diff --git a/docs/.gitignore b/docs/.gitignore
index a22b0f9b..957eff64 100644
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -24,4 +24,4 @@ logs
!.env.example
# Generated files
-docs/latest-commit.json
+content/latest-commit.json
diff --git a/docs/components/Page/PageFooter.vue b/docs/components/Page/PageFooter.vue
index 67e92065..7441c8de 100644
--- a/docs/components/Page/PageFooter.vue
+++ b/docs/components/Page/PageFooter.vue
@@ -12,7 +12,8 @@ import { siteMeta } from '~/meta'
- Copyright © 2023, Skyost
+ Copyright © 2023, Skyost.
+ Revision .
diff --git a/docs/content/docs.md b/docs/content/docs.md
index 8d418883..0a9abbce 100644
--- a/docs/content/docs.md
+++ b/docs/content/docs.md
@@ -138,7 +138,7 @@ await discovery.stop();
# In-depth example
If you want a full
example, don't hesitate to check
-[this one](https://github.com/Skyost/Bonsoir/tree/master/bonsoir/example) on Github.
+[this one](https://github.com/Skyost/Bonsoir/tree/master/packages/bonsoir/example) on Github.
To run it :
diff --git a/docs/nuxt.config.ts b/docs/nuxt.config.ts
index 6e773ee3..3af28b98 100644
--- a/docs/nuxt.config.ts
+++ b/docs/nuxt.config.ts
@@ -75,5 +75,11 @@ export default defineNuxtConfig({
cname: {
hostname: siteMeta.url
+ },
+
+ runtimeConfig: {
+ public: {
+ url: siteMeta.url
+ }
}
})
diff --git a/packages/bonsoir/README.md b/packages/bonsoir/README.md
index 64e8e6ca..017e1353 100644
--- a/packages/bonsoir/README.md
+++ b/packages/bonsoir/README.md
@@ -19,6 +19,10 @@ or Good afternoon
depending on the current moment of the day).
![Bonsoir preview](https://github.com/Skyost/Bonsoir/raw/master/packages/bonsoir/images/preview.gif)
+## Installation
+
+See [how to install](https://bonsoir.skyost.eu/docs/#installation) on the Bonsoir website.
+
## Code snippet
Here is how you can broadcast your service using _Bonsoir_ :
@@ -73,66 +77,6 @@ await discovery.stop();
If you want a full
example, don't hesitate to check [this one](https://github.com/Skyost/Bonsoir/tree/master/bonsoir/example) on Github.
-## Installation
-
-### Minimum OS requirements
-
-Depending on your project targets, you need at least :
-
-* Android : API level 21 (Android 5.0).
-* iOS : 12.0.
-* macOS : 10.11 (El Capitan).
-* Windows 10 (19H1/1903) (Mai 2019 Update).
-* Linux with [Avahi](https://www.avahi.org/).
-
-### Update deployment target
-
-If you want to use this plugin on iOS, you must update your deployment target to _at least_ 13.0. At the top of `ios/Podfile`, add the following :
-
-```
-platform :ios, '13.0'
-```
-
-Also, open your iOS project in Xcode and select Runner, Targets -> Runner and then the "General" tab.
-Under the "Minimum Deployments" section, update the iOS version to 13.0 or higher.
-
-You'll have to do the same steps if you want to use this plugin on macOS. Update your deployment
-target to _at least_ 10.15. At the top of `macOS/Podfile` :
-
-```
-platform :osx, '10.15'
-```
-
-Open your macOS project in xCode and in the "Minimum Deployments" section, update the macOS version
-to 10.15 or higher.
-
-### Update `Info.plist`
-
-If you're building your app for iOS 14 or higher, you have to edit your `Info.plist` file. Just add
-the following lines :
-
-```xml
-
-NSLocalNetworkUsageDescription
-Describe here why you want to use Bonsoir.
-NSBonjourServices
-
- _first-service._tcp
- _second-service._tcp
- _third-service._tcp
-
-
-```
-
-Don't forget to edit them according to your needs.
-
-## Final notes
-
-This plugin [cannot be tested on an Android emulator](https://stackoverflow.com/a/46926325/3608831)
-(well it can, but the only services that you are able to discover are the ones broadcasted by your emulator).
-
-The hand icon has been created by [Vitaly Gorbachev](https://www.flaticon.com/authors/vitaly-gorbachev).
-
## Contributions
You have a lot of options to contribute to this project ! You can :
diff --git a/packages/bonsoir/pubspec.yaml b/packages/bonsoir/pubspec.yaml
index 65f0905e..c20e35b6 100644
--- a/packages/bonsoir/pubspec.yaml
+++ b/packages/bonsoir/pubspec.yaml
@@ -1,5 +1,6 @@
name: bonsoir
description: A Zeroconf library that allows you to discover network services and to broadcast your own. Based on Apple Bonjour and Android NSD.
+homepage: https://bonsoir.skyost.eu
repository: https://github.com/Skyost/Bonsoir/tree/master/packages/bonsoir
issue_tracker: https://github.com/Skyost/Bonsoir/issues
version: 5.0.2
diff --git a/packages/bonsoir_android/pubspec.yaml b/packages/bonsoir_android/pubspec.yaml
index ba33eb62..e6462dce 100644
--- a/packages/bonsoir_android/pubspec.yaml
+++ b/packages/bonsoir_android/pubspec.yaml
@@ -1,5 +1,6 @@
name: bonsoir_android
description: Android implementation of the Bonsoir plugin.
+homepage: https://bonsoir.skyost.eu
repository: https://github.com/Skyost/Bonsoir/tree/master/packages/bonsoir_android
issue_tracker: https://github.com/Skyost/Bonsoir/issues
version: 5.0.2
diff --git a/packages/bonsoir_darwin/pubspec.yaml b/packages/bonsoir_darwin/pubspec.yaml
index 63825b13..010c3be9 100644
--- a/packages/bonsoir_darwin/pubspec.yaml
+++ b/packages/bonsoir_darwin/pubspec.yaml
@@ -1,5 +1,6 @@
name: bonsoir_darwin
description: Darwin (iOS & macOS) implementation of the Bonsoir plugin.
+homepage: https://bonsoir.skyost.eu
repository: https://github.com/Skyost/Bonsoir/tree/master/packages/bonsoir_darwin
issue_tracker: https://github.com/Skyost/Bonsoir/issues
version: 5.0.1
diff --git a/packages/bonsoir_linux/pubspec.yaml b/packages/bonsoir_linux/pubspec.yaml
index 71430ec5..2e0d0681 100644
--- a/packages/bonsoir_linux/pubspec.yaml
+++ b/packages/bonsoir_linux/pubspec.yaml
@@ -1,5 +1,6 @@
name: bonsoir_linux
description: Linux implementation of the Bonsoir plugin.
+homepage: https://bonsoir.skyost.eu
repository: https://github.com/Skyost/Bonsoir/tree/master/packages/bonsoir_linux
issue_tracker: https://github.com/Skyost/Bonsoir/issues
version: 5.0.0
diff --git a/packages/bonsoir_platform_interface/pubspec.yaml b/packages/bonsoir_platform_interface/pubspec.yaml
index e2e2b9ac..32a9b939 100644
--- a/packages/bonsoir_platform_interface/pubspec.yaml
+++ b/packages/bonsoir_platform_interface/pubspec.yaml
@@ -1,5 +1,6 @@
name: bonsoir_platform_interface
description: Common platform interface for the Bonsoir plugin.
+homepage: https://bonsoir.skyost.eu
repository: https://github.com/Skyost/Bonsoir/tree/master/packages/bonsoir_platform_interface
version: 5.0.0
diff --git a/packages/bonsoir_windows/pubspec.yaml b/packages/bonsoir_windows/pubspec.yaml
index 71e7e767..88c3b295 100644
--- a/packages/bonsoir_windows/pubspec.yaml
+++ b/packages/bonsoir_windows/pubspec.yaml
@@ -1,5 +1,6 @@
name: bonsoir_windows
description: Windows implementation of the Bonsoir plugin.
+homepage: https://bonsoir.skyost.eu
repository: https://github.com/Skyost/Bonsoir/tree/master/packages/bonsoir_windows
issue_tracker: https://github.com/Skyost/Bonsoir/issues
version: 5.0.0