Skip to content

Commit 03fc0cc

Browse files
committed
update README
1 parent 87fb9a8 commit 03fc0cc

File tree

1 file changed

+29
-4
lines changed

1 file changed

+29
-4
lines changed

README.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,34 @@
11
# Kotlin WebExtensions API Declarations Generator
22

3-
This project has the purpose of generating Kotlin JS declarations for the Firefox WebExtensions API from the offical schema files.
3+
This project contains Kotlin JS declarations for the Firefox WebExtensions API generated from the offical schema files.
4+
5+
The schema is taken from https://github.com/mozilla/gecko-dev/tree/master/browser/components/extensions/schemas and https://github.com/mozilla/gecko-dev/tree/master/toolkit/components/extensions/schemas.
6+
7+
## How to use in a Gradle project
8+
9+
You can include the declarations in your project by using jitpack.io.
10+
11+
In your `build.gradle` add
12+
13+
```groovy
14+
repositories {
15+
// ...
16+
maven { url 'https://jitpack.io' }
17+
}
18+
```
19+
20+
and
21+
22+
```groovy
23+
dependencies {
24+
// ...
25+
compile 'com.github.cypressious.kotlin-webextensions-declarations:webextensions-declarations:v0.1'
26+
}
27+
```
28+
29+
## Example project
30+
31+
See https://github.com/cypressious/second-firefox-extension-kotlin
432

5-
The schema is taken from https://github.com/mozilla/gecko-dev/tree/master/browser/components/extensions/schemas.
633

7-
## Status
834

9-
Work in Progress

0 commit comments

Comments
 (0)