11<div align =" center " >
22 <a href =" https://openauthenticator.app " >
3- <img src="https://github.com/Skyost/OpenAuthenticator /raw/main/docs/public/images/logo.svg" alt="Logo" width="120" height="120">
3+ <img src="https://github.com/openauthenticator-app/openauthenticator /raw/main/docs/public/images/logo.svg" alt="Logo" width="120" height="120">
44 </a >
55
66 <h3 >Open Authenticator</h3 >
2121 </p >
2222
2323 <p >
24- <img src="https://img.shields.io/github/license/openauthenticator-app/backend " alt="License">
25- <img src="https://img.shields.io/github/languages/top/openauthenticator-app/backend " alt="Top language">
26- <img src="https://img.shields.io/github/stars/openauthenticator-app/backend " alt="GitHub stars">
24+ <img src="https://img.shields.io/github/license/openauthenticator-app/openauthenticator " alt="License">
25+ <img src="https://img.shields.io/github/languages/top/openauthenticator-app/openauthenticator " alt="Top language">
26+ <img src="https://img.shields.io/github/stars/openauthenticator-app/openauthenticator " alt="GitHub stars">
2727 </p >
2828</div >
2929
@@ -40,10 +40,13 @@ The project focuses on three core ideas :
4040
4141Open Authenticator currently targets Android, iOS, Windows, macOS and Linux.
4242
43+ > [ !TIP]
44+ > If you like this project, consider starring it on GitHub !
45+
4346## Features
4447
4548- Cross-platform Flutter application for mobile and desktop.
46- - Free and open-source software under the [ GPL v3.0 license] ( https://github.com/Skyost/OpenAuthenticator /blob/main/LICENSE ) .
49+ - Free and open-source software under the [ GPL v3.0 license] ( https://github.com/openauthenticator-app/openauthenticator /blob/main/LICENSE ) .
4750- Secure local storage for your OTP data.
4851- QR code scanning and ` otpauth:// ` link handling.
4952- Optional synchronization across devices with self-hostable backend support.
@@ -63,8 +66,8 @@ Prebuilt packages and store links are available on the [official website](https:
6366
6467### Prerequisites
6568
66- - A recent stable version of Flutter.
67- - Dart SDK ` >=3.10.0 <4.0.0 ` .
69+ - A recent stable version of ** Flutter** .
70+ - ** Dart** SDK ` >=3.10.0 <4.0.0 ` .
6871- Platform toolchains for the targets you want to run.
6972
7073It is recommended to stay on Flutter stable :
@@ -88,20 +91,20 @@ flutter pub get
8891
8992Some files used by the app are generated or refreshed during setup.
9093
91- 1 . Compile SVG assets to ` .si ` :
94+ First, compile SVG assets to ` .si ` :
9295
9396``` sh
9497dart run open_authenticator:compile_svg
9598```
9699
97- 2 . Generate source files used by code generation:
100+ Then, generate source files used by code generation :
98101
99102``` sh
100103dart run build_runner build --delete-conflicting-outputs
101104dart run slang
102105```
103106
104- 3 . Generate ` lib/app.dart ` for your local build:
107+ Last but not least, generate ` lib/app.dart ` for your local build :
105108
106109``` sh
107110dart run open_authenticator:generate
@@ -127,24 +130,26 @@ you want to run against.
127130
128131### Run the app
129132
133+ To run the app :
134+
130135``` sh
131136flutter run
132137```
133138
134139## Contributing
135140
136141Contributions are more than welcome. For setup details, contribution rules and PR expectations, read
137- [ CONTRIBUTING.md] ( https://github.com/Skyost/OpenAuthenticator /blob/main/CONTRIBUTING.md ) .
142+ [ CONTRIBUTING.md] ( https://github.com/openauthenticator-app/openauthenticator /blob/main/CONTRIBUTING.md ) .
138143
139144You can also help by :
140145
141146- reporting bugs or suggesting features in the
142- [ issue tracker] ( https://github.com/Skyost/OpenAuthenticator /issues ) ;
147+ [ issue tracker] ( https://github.com/openauthenticator-app/openauthenticator /issues ) ;
143148- improving translations through the
144149 [ translation page] ( https://openauthenticator.app/translate/ ) ;
145150- submitting fixes for documentation, UI text or code.
146151
147- ## Support The Project
152+ ## Support the project
148153
149154If you want to support Open Authenticator financially, you can use :
150155
@@ -154,4 +159,5 @@ If you want to support Open Authenticator financially, you can use :
154159
155160## License
156161
157- Open Authenticator is licensed under the [ GNU General Public License v3.0] ( LICENSE ) .
162+ Open Authenticator is licensed under the
163+ [ GNU General Public License v3.0] ( https://github.com/openauthenticator-app/openauthenticator/blob/main/LICENSE ) .
0 commit comments