Skip to content

Commit

Permalink
chore(docs): Updated website, README and links !
Browse files Browse the repository at this point in the history
  • Loading branch information
Skyost committed Nov 23, 2023
1 parent 0f96825 commit d33c174
Show file tree
Hide file tree
Showing 11 changed files with 20 additions and 63 deletions.
2 changes: 1 addition & 1 deletion docs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ logs
!.env.example

# Generated files
docs/latest-commit.json
content/latest-commit.json
3 changes: 2 additions & 1 deletion docs/components/Page/PageFooter.vue
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ import { siteMeta } from '~/meta'
</p>
<p>
<small>
Copyright &copy; 2023, <a href="https://skyost.eu">Skyost</a>
Copyright &copy; 2023, <a href="https://skyost.eu">Skyost</a>.
Revision <current-commit-sha />.
</small>
</p>
<ul class="icons">
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ await discovery.stop();
# In-depth example

If you want a <q>full</q> 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 :

Expand Down
6 changes: 6 additions & 0 deletions docs/nuxt.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,5 +75,11 @@ export default defineNuxtConfig({

cname: {
hostname: siteMeta.url
},

runtimeConfig: {
public: {
url: siteMeta.url
}
}
})
64 changes: 4 additions & 60 deletions packages/bonsoir/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ or <q>Good afternoon</q> 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_ :
Expand Down Expand Up @@ -73,66 +77,6 @@ await discovery.stop();

If you want a <q>full</q> 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

<key>NSLocalNetworkUsageDescription</key>
<string>Describe here why you want to use Bonsoir.</string>
<key>NSBonjourServices</key>
<array>
<string>_first-service._tcp</string>
<string>_second-service._tcp</string>
<string>_third-service._tcp</string>
<!-- Add more here -->
</array>
```

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 :
Expand Down
1 change: 1 addition & 0 deletions packages/bonsoir/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions packages/bonsoir_android/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions packages/bonsoir_darwin/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions packages/bonsoir_linux/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions packages/bonsoir_platform_interface/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -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

Expand Down
1 change: 1 addition & 0 deletions packages/bonsoir_windows/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit d33c174

Please sign in to comment.