Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lukin0110 committed Feb 25, 2015
1 parent cba34c1 commit aa1594f
Show file tree
Hide file tree
Showing 4 changed files with 81 additions and 3 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@ gradle-app.setting
poeditor-gradle.iml
example-project/App/
example-project/gradle.properties

gradle.properties
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,25 @@ Sync terms:
```
gradle poeditorSyncTerms
```

Configuration
=============

Example configuration:

```groovy
poeditor {
apikey 'apikey here'
projects {
androidApp {
projectId 'project id here'
type 'android_strings'
terms 'App/src/main/res/values/strings.xml'
trans 'en', 'App/src/main/res/values/strings.xml'
trans 'nl', 'App/src/main/res/values-nl/strings.xml'
trans 'fr', 'App/src/main/res/values-fr/strings.xml'
}
}
}
```
56 changes: 56 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
apply plugin: 'java'
apply plugin: 'groovy'
apply plugin: 'signing'
apply plugin: 'maven'
apply plugin: 'maven-publish'

// Artifact settings
group = 'be.lukin.poeditor'
version='0.1.0'
archivesBaseName = 'gradle'

def _name = 'Gradle Plugin for POEditor'
def _description = 'Gradle plugin to sync translations with POEditor'

repositories {
mavenLocal()
mavenCentral()
Expand Down Expand Up @@ -39,8 +44,59 @@ publishing {

uploadArchives {
repositories {
/*
mavenDeployer {
}
*/
mavenDeployer {
beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }

repository(url: uri('./build/repo'))

/*
repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") {
authentication(userName: ossrhUsername, password: ossrhPassword)
}
snapshotRepository(url: "https://oss.sonatype.org/content/repositories/snapshots/") {
authentication(userName: ossrhUsername, password: ossrhPassword)
}*/

pom.project {
name _name
packaging 'jar'
artifactId archivesBaseName
description _description
url 'https://github.com/lukin0110/poeditor-gradle/'
inceptionYear '2015'

scm {
url 'https://github.com/lukin0110/poeditor-gradle/'
connection 'scm:https://github.com/lukin0110/poeditor-gradle.git'
developerConnection 'scm:git://github.com/lukin0110/poeditor-gradle.git'
}

licenses {
license {
name 'The Apache License, Version 2.0'
url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
}
}

developers {
developer {
id 'lukin0110'
name 'Maarten Huijsmans'
email 'maarten@lukin.be'
}
}

issueManagement {
system 'GitHub issues'
url 'https://github.com/lukin0110/poeditor-gradle/issues'
}
}
}
}
}
4 changes: 1 addition & 3 deletions docs/TODO.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# Todo

- upload gradle plugin (open ticket etc)

Later:
- proper exceptions for invalid params
- splitup tasks in separate classes
- add plugin to build process: https://github.com/crashlytics/gradle-plugin-example
- .travis.yml
- .travis.yml & unit testing
- document gradle plugin: configuration

0 comments on commit aa1594f

Please # to comment.