Skip to content

Commit 9a70f03

Browse files
committed
refactor: move vega os to compatibility flag
1 parent 8998f5d commit 9a70f03

File tree

8 files changed

+25684
-22396
lines changed

8 files changed

+25684
-22396
lines changed

README.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414

1515
> [!TIP]
1616
> Are you looking for an integration with VS Code? Check out our official extension:
17-
> * https://github.com/react-native-community/vscode-react-native-directory
17+
>
18+
> - https://github.com/react-native-community/vscode-react-native-directory
1819
1920
## How do I know I'm at the right place?
2021

@@ -44,10 +45,7 @@
4445
{
4546
"githubUrl": "<GITHUB REPOSITORY URL>",
4647
"npmPkg": "<OPTIONAL NPM PACKAGE NAME>",
47-
"examples": [
48-
"<THE URL TO REPO>",
49-
"<THE URL TO A SNACK>"
50-
],
48+
"examples": ["<THE URL TO REPO>", "<THE URL TO A SNACK>"],
5149
"images": ["<PUBLIC URL TO RELATED IMAGE>"],
5250
"ios": false,
5351
"android": false,
@@ -71,16 +69,16 @@
7169
> then the name, description, homepage, and topics (keywords) will be extracted from `package.json` in the package subdirectory.
7270
> However, GitHub stats will be based on the monorepo, because there isn't really another option.
7371
74-
7572
### Library fields description
7673

7774
#### ⚙️ General
7875

7976
- #### `githubUrl` **(required)**
8077

8178
**(string)** - URL to the package GitHub repository (currently other Git hosts are not supported).
82-
> [!WARNING]
83-
> Package also needs to be published to the NPM registry, because it is a source of crucial data for the directory.
79+
80+
> [!WARNING]
81+
> Package also needs to be published to the NPM registry, because it is a source of crucial data for the directory.
8482
8583
- #### `npmPkg`
8684

@@ -120,15 +118,15 @@
120118
**(boolean)** - can be used with [`react-native-tvos`](https://github.com/react-native-tvos/react-native-tvos).
121119
- #### `visionos`
122120
**(boolean)** - can be used with [`react-native-visionos`](https://github.com/callstack/react-native-visionos).
123-
- #### `vegaos`
124-
**(boolean)** - can be used with [`Vega OS`](https://developer.amazon.com/docs/react-native-vega/0.72/react_overview.html) platform.
125121

126122
#### ✅ Compatibility
127123

128124
- #### `expoGo`
129125
**(boolean)** - works with [Expo Go](https://docs.expo.dev/get-started/expo-go/) — an open-source sandbox app, without using [dev clients](https://docs.expo.dev/develop/development-builds/introduction/) or [prebuild](https://docs.expo.dev/workflow/continuous-native-generation/).
130126
- #### `fireos`
131127
**(boolean)** - works on Amazon Fire OS.
128+
- #### `vegaos`
129+
**(boolean)** - works with [Vega OS](https://developer.amazon.com/docs/react-native-vega/0.72/react_overview.html).
132130

133131
> [!TIP]
134132
> **Any** library can be used with Expo, if you use dev clients or prebuild.
@@ -150,6 +148,7 @@
150148
### 📝 Additional context for tags
151149

152150
- #### `newArchitectureNote`
151+
153152
**(string)** - provide a note for the New Architecture support status, if a boolean `"true"` or `"false"` is not sufficient to describe the state of New Architecture support.
154153

155154
- #### `alternatives`
@@ -173,7 +172,7 @@ You should be able to visit `localhost:3000` in your browser.
173172

174173
- Visit https://github.com/settings/developers to get your keys (don't worry about the callback URL, put whatever you want).
175174
- Load the `GITHUB_TOKEN` environment variable into your shell.
176-
- Set `ONLY_WRITE_LOCAL_DATA_FILE` to `true` in *scripts/build-and-score-data.ts* to skip fetching and updating store blob from Vercel and instead use and update the local `assets/data.json` file.
175+
- Set `ONLY_WRITE_LOCAL_DATA_FILE` to `true` in _scripts/build-and-score-data.ts_ to skip fetching and updating store blob from Vercel and instead use and update the local `assets/data.json` file.
177176

178177
This command creates site data in `./assets/data.json`
179178

@@ -199,31 +198,32 @@ https://reactnative.directory/api/libraries
199198
<summary><b>More details on API queries</b></summary>
200199
<br/>
201200

202-
```
203-
https://reactnative.directory/api/libraries?search=webgl
204-
```
205-
206-
- Returns a list of all libraries in `JSON` format that have the keyword `webgl`.
207-
208-
```
209-
https://reactnative.directory/api/libraries?search=webgl&expoGo=true
210-
```
211-
212-
- Returns a list of all libraries in `JSON` format that have the keyword `webgl` and work with Expo Go app.
213-
214-
```
215-
https://reactnative.directory/api/libraries?search=webgl&expoGo=true&android=true
216-
```
217-
218-
- Returns a list of all libraries in `JSON` format that have the keyword `webgl`, work with Expo Go app and Android.
219-
220-
```
221-
https://reactnative.directory/api/libraries?search=webgl&expoGo=true&android=true&isPopular=true
222-
```
223-
224-
- Returns a list of all libraries in `JSON` format that have the keyword `webgl`, work with Expo Go app, Android and are popular based on the scoring criterion.
225-
226-
All the possible query parameters represents [`Query` type](https://github.com/react-native-community/directory/blob/main/types/index.ts#L14-L36).
201+
```
202+
https://reactnative.directory/api/libraries?search=webgl
203+
```
204+
205+
- Returns a list of all libraries in `JSON` format that have the keyword `webgl`.
206+
207+
```
208+
https://reactnative.directory/api/libraries?search=webgl&expoGo=true
209+
```
210+
211+
- Returns a list of all libraries in `JSON` format that have the keyword `webgl` and work with Expo Go app.
212+
213+
```
214+
https://reactnative.directory/api/libraries?search=webgl&expoGo=true&android=true
215+
```
216+
217+
- Returns a list of all libraries in `JSON` format that have the keyword `webgl`, work with Expo Go app and Android.
218+
219+
```
220+
https://reactnative.directory/api/libraries?search=webgl&expoGo=true&android=true&isPopular=true
221+
```
222+
223+
- Returns a list of all libraries in `JSON` format that have the keyword `webgl`, work with Expo Go app, Android and are popular based on the scoring criterion.
224+
225+
All the possible query parameters represents [`Query` type](https://github.com/react-native-community/directory/blob/main/types/index.ts#L14-L36).
226+
227227
</details>
228228

229229
## I don't like how you calculate scores.

0 commit comments

Comments
 (0)