Skip to content

Update README #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 11, 2018
Merged

Update README #21

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8b129ab
README: latest version is v0.3
jmfayard Nov 9, 2018
0c5f2f0
Update README
jmfayard Nov 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ A generator for Kotlin JS declarations for the Firefox WebExtensions API from th

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.

See KotlinConf 2018 talk: [Building a Browser Extension with Kotlin](https://kotlinconf.com/talks/#session=21914)

See https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions

## Example projects

- https://github.com/cypressious/webextension-search-kotlin-docs
- https://github.com/cypressious/second-firefox-extension-kotlin


## How to use in a Gradle project

You can include the declarations in your project by using jitpack.io.
Expand All @@ -22,13 +32,6 @@ and
```groovy
dependencies {
// ...
compile 'com.github.cypressious.kotlin-webextensions-declarations:webextensions-declarations:v0.2'
compile 'com.github.cypressious.kotlin-webextensions-declarations:webextensions-declarations:v0.3'
}
```

## Example project

See https://github.com/cypressious/second-firefox-extension-kotlin