Skip to content

Commit b33d2ff

Browse files
committed
chore(documentation): updated README.md, fixed links and made examples more prominent
1 parent 7eb522c commit b33d2ff

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,14 @@ but also use Godot's Signals and also provide in-editor tools to work with Godot
2929

3030
**The overarching mission is:** *Providing a great Developer Experience!*
3131

32+
## Example Projects
33+
You can find an example project in the [godot-playfab-example](https://github.com/Structed/godot-playfab-example) repository. However, the example projects are not included in the AssetLib or Itch.io packages, as to not confuse users. There are example projects for multiple use-cases in the [godot-playfab-example](https://github.com/Structed/godot-playfab-example) repository, such as general login and data retrieval, analytics as well as how to use GodotSteam with godot-playfab to log into PlayFab using Steam!
34+
3235
## Users
3336
I am proud to say that there are already some games using `godot-playfab` in production! If you want to be listed here, please let me know!
3437

3538
- [**Dome Keeper**](https://store.steampowered.com/app/1637320/Dome_Keeper/) by [Bippinbits](https://bippinbits.com/)
3639

37-
# Need Help? Found a Bug? Have an idea for a feature?
38-
Don't hesitate and [join our Discord](https://discord.gg/7K7q2YuNXe)! Everyone is welcome, and we're looking forward to hearing from you!
39-
Or create an [issue](/issues) directly in the repo. All your input is **very much appreciated**!
40-
41-
4240
## Demo
4341
![Demo](demo-scene.gif)
4442

@@ -56,11 +54,12 @@ See [Connecting Signals](addons/godot-playfab/docs/connecting-signals.md)
5654
## Usage Guide & Examples
5755
See the [User Documentation](addons/godot-playfab/README.md)
5856

59-
## Example Projects
60-
You can find an example project in [this GitHub repository](https://github.com/Structed/godot-playfab). However, the example projects are not included in the AssetLib or Itch.io packages, as to not confuse user. There are example projects for multiple use-cases in the [godot-playfab-example](https://github.com/Structed/godot-playfab-example) repository.
61-
6257
## Maintainer Documentation
6358
See [Maintainer Documentation](docs/README.md).
6459

60+
# Need Help? Found a Bug? Have an idea for a feature?
61+
Don't hesitate and [join our Discord](https://discord.gg/7K7q2YuNXe)! Everyone is welcome, and we're looking forward to hearing from you!
62+
Or create an [issue](https://github.com/Structed/godot-playfab/issues/new/choose) directly in the repo. All your input is **very much appreciated**!
63+
6564
# Thanks
6665
Thanks to [lentsius-bark](https://github.com/lentsius-bark) for the wonderful re-design of the logo and splash screen ❤

addons/godot-playfab/docs/Logins/login-steam-godotsteam.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ This page is an advanced example that will show you how to login with Steam on P
1717
</br>
1818
Please check their documentation on how to use GodotSteam.
1919

20+
## Example
21+
You can check out a working example in the [godot-playfab-example](https://github.com/Structed/godot-playfab-example) repository. Just load up the `godot-steam` project in that repository!
22+
2023
## Setup
2124

2225
There are a couple of different ways to install GodotSteam but for this example, we gonna used the GDExtension available for Godot 4.x.

0 commit comments

Comments
 (0)