https://github.com/nativescript-community/licenses
https://github.com/nativescript-community/licenses
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/nativescript-community/licenses
- Owner: nativescript-community
- License: apache-2.0
- Created: 2020-10-05T18:38:19.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-06T21:05:12.000Z (over 2 years ago)
- Last Synced: 2025-02-05T09:48:36.288Z (over 1 year ago)
- Language: TypeScript
- Size: 94.7 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nativescript - Licenses - A NativeScript plugin to generate licenses JSON files. (Plugins / Utility Plugins)
README
[npm-image]: http://img.shields.io/npm/v/@nativescript-community/licenses.svg
[npm-url]: https://npmjs.org/package/@nativescript-community/licenses
[downloads-image]: http://img.shields.io/npm/dm/@nativescript-community/licenses.svg
### Installation
On iOS you need to run this first:
```
gem install cocoapods-acknowledgements
```
## Usage
This plugin is a plugin to easily integrate licenses used your apps.
The plugin will automatically generate `licenses.json`
You simply need to load the `licenses.json` from anywhere in your app using either `require('licenses.json')` or `require('~/licenses.json')`
You can then simply `require` that file to use it in your app.
Here is an example JSON file format (`moduleDescription` not present on Android):
```json
{
"dependencies": [
{
"moduleName": "com.airbnb.android:lottie",
"moduleDescription": "description",
"moduleUrl": "https://github.com/airbnb/lottie-android",
"moduleVersion": "3.4.2",
"moduleLicense": "Apache License, Version 2.0",
"moduleLicenseUrl": "https://www.apache.org/licenses/LICENSE-2.0"
}
]
}
```