dkhamsing
parent
c777aca9df
commit
3828fce05e
|
|
@ -11,9 +11,9 @@ Adding a `JSON` entry
|
|||
|
||||
### New entries go to the end of the file
|
||||
|
||||
Example: https://github.com/dkhamsing/open-source-ios-apps/pull/281/files
|
||||
|
||||
|
||||
At the end of **contents.json**, add an entry at `}]`
|
||||
At the end of **contents.json**, add an entry at `}]`.
|
||||
|
||||
```js
|
||||
"stars": 100
|
||||
|
|
@ -25,33 +25,84 @@ Insert a comma between `}` and `]` and create a new entry with the format below.
|
|||
|
||||
### Format
|
||||
|
||||
At minimum
|
||||
Feel free to cut and paste the snippet below
|
||||
|
||||
```js
|
||||
{
|
||||
"title": "MrCode",
|
||||
"category": "github",
|
||||
"description": "GitHub iPhone app that can cache Markdown content",
|
||||
"source": "https://github.com/haolloyin/MrCode" // note, no comma on last line
|
||||
}
|
||||
{
|
||||
"title": "Name of the app",
|
||||
"category": "Category name",
|
||||
"description": "What this app does",
|
||||
"source": "Link to source, usually GitHub"
|
||||
}
|
||||
```
|
||||
|
||||
Optionally
|
||||
#### Details
|
||||
|
||||
`title`, `category`, `description` and `source` are required, the rest is optional.
|
||||
|
||||
```js
|
||||
{
|
||||
{
|
||||
"title": "App name",
|
||||
"category": ["github", "parse"],
|
||||
"description": "Describe what this app does",
|
||||
"lang": "zho", // ISO 639-2 code
|
||||
"source": "https://github.com/user/repo",
|
||||
"homepage": "https://awesome-url",
|
||||
"itunes": "https://itunes.apple.com/app/id1234567890",
|
||||
"tags": ["swift"],
|
||||
"stars": 200 // number of GitHub stars
|
||||
}
|
||||
"itunes": "https://itunes.apple.com/app/id1234567890",
|
||||
"lang": "zho",
|
||||
"stars": 200,
|
||||
"tags": ["swift"]
|
||||
}
|
||||
```
|
||||
|
||||
For `lang` (language), use ISO 639-2 https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes
|
||||
- `category`: Use an approved category from this list https://github.com/dkhamsing/open-source-ios-apps/wiki/Categories
|
||||
|
||||
- `category`: An app can belong to more than one category, in that case use a list format in the example above
|
||||
|
||||
- `stars`: Number of GitHub stars
|
||||
|
||||
- `lang`: App language in the form of ISO 639-2 code https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes
|
||||
|
||||
- `tags`: List of app attribute tags, use `swift` if the app is written in Swift
|
||||
|
||||
#### Examples
|
||||
|
||||
Pull request:
|
||||
|
||||
- https://github.com/dkhamsing/open-source-ios-apps/pull/281
|
||||
- https://github.com/dkhamsing/open-source-ios-apps/pull/281/files
|
||||
|
||||
```js
|
||||
{
|
||||
"title": "Firefox",
|
||||
"category": ["browser", "official"],
|
||||
"description": "Official Firefox app",
|
||||
"source": "https://github.com/mozilla/firefox-ios",
|
||||
"itunes": "https://itunes.apple.com/app/firefox-web-browser/id989804926",
|
||||
"stars": 5641,
|
||||
"tags": ["swift"]
|
||||
}
|
||||
```
|
||||
|
||||
```js
|
||||
{
|
||||
"title": "VLC",
|
||||
"category": ["media", "official"],
|
||||
"description": "Media Player",
|
||||
"source": "https://github.com/videolan/vlc",
|
||||
"homepage": "https://www.videolan.org/",
|
||||
"itunes": "https://itunes.apple.com/app/vlc-for-ios/id650377962",
|
||||
"stars": 1753
|
||||
}
|
||||
```
|
||||
|
||||
```js
|
||||
{
|
||||
"title": "Simple Reader",
|
||||
"category": "hacker-news",
|
||||
"source": "https://github.com/rnystrom/HackerNewsReader",
|
||||
"itunes": "https://itunes.apple.com/app/simple-reader-free-open-source/id1000995253",
|
||||
"stars": 182
|
||||
}
|
||||
```
|
||||
|
||||
Thanks for contributing :tada:
|
||||
|
|
|
|||
|
|
@ -8,34 +8,20 @@ To create a new category, please open an issue (see CONTRIBUTING) -->
|
|||
|
||||
1. [ ] Project URL:
|
||||
2. [ ] One project per pull request
|
||||
3. [ ] Avoid iOS or open-source in description as it is assumed
|
||||
4. [ ] Use this commit title format if applicable: Add app-name by @github-username
|
||||
5. [ ] Use approved format for your entry
|
||||
3. [ ] Project added at the end of the list (a script sorts projects automatically)
|
||||
4. [ ] Avoid iOS or open-source in description as it is assumed
|
||||
5. [ ] Use this commit title format if applicable: Add app-name by @github-username
|
||||
6. [ ] Use approved format for your entry
|
||||
|
||||
<!-- Approved Format
|
||||
|
||||
At minimum
|
||||
{
|
||||
"title": "Name of the app",
|
||||
"category": "Category name",
|
||||
"description": "What this app does",
|
||||
"source": "Link to source, usually GitHub"
|
||||
}
|
||||
|
||||
{
|
||||
"title": "MrCode",
|
||||
"category": "github",
|
||||
"description": "GitHub iPhone app that can cache Markdown content",
|
||||
"source": "https://github.com/haolloyin/MrCode" // note, no comma on last line
|
||||
}
|
||||
|
||||
|
||||
Optionally
|
||||
|
||||
{
|
||||
"title": "MrCode",
|
||||
"category": ["github", "parse"],
|
||||
"description": "GitHub iPhone app that can cache Markdown content",
|
||||
"lang": "zho",
|
||||
"source": "https://github.com/haolloyin/MrCode",
|
||||
"homepage": "https://awesome-url",
|
||||
"itunes": "https://itunes.apple.com/app/id1234567890",
|
||||
"tags": ["swift"],
|
||||
"stars": 200
|
||||
}
|
||||
For more information, read https://github.com/dkhamsing/open-source-ios-apps/blob/master/.github/CONTRIBUTING.md
|
||||
|
||||
-->
|
||||
|
|
|
|||
Loading…
Reference in New Issue