提交 0c294ca3 编写于 作者: E Eric Frohnhoefer

Update README, CONTRIBUTING, and ISSUE_TEMPLATE

Change-Id: I5762845423da9b8b4a2d1f15fa31fbc53131201b
上级 d85c2e2e
......@@ -23,7 +23,7 @@ The workflow that we support:
We've use the standard [Android Testing tools](http://developer.android.com/tools/testing/testing_android.html). Most classes are currently using AndroidTestCase, but will slowly be migrated to JUnit 4.
```
Running ./gradlew connectedCheck will perform the needed tests
Running ./gradlew test connectedCheck will perform the needed tests
```
## Styleguide
......
This form is for reporting issues in the Twitter Kit Android library. For all other developer questions/issues about Twitter please visit [Twitter Community](https://twittercommunity.com/).
We welcome your contributions to improve the SDKs — whether adding new features, creating your own library that uses Twitter Kit, or fixing bugs you find in the code. We'd love to work with you so that Twitter Kit grows with your needs.
**Bug Report**
We work constantly to fix bugs, tweak functionality and improve device support. Providing detailed feedback will help us to quickly resolve your issue.
......@@ -12,7 +14,7 @@ We work constantly to fix bugs, tweak functionality and improve device support.
**Feature Request**
We are seeking fix contributions over external feature PRs. If you have anything you'd like to contribute, we recommend discussing it with the core team before writing it.
If you have anything you'd like to contribute, we recommend discussing it with the core team before writing it.
* Describe feature in as much detail as possible:
* Include sample usage where appropriate:
\ No newline at end of file
......@@ -2,12 +2,23 @@
Twitter Kit is a multi-module gradle project containing several Twitter SDKs including TweetComposer, TwitterCore, and TweetUi. Twitter Kit is designed to make interacting with Twitter seamless and efficient.
Using Twitter Kit from source in production applications is not officially supported. Please utilize the available binaries.
## Twitter Kit Features
## Download
* Display Tweets and timelines
* Compose Tweets
* Monetize with MoPub integration
* Log in with Twitter
* Access the Twitter API
## Getting Started
* Generate your Twitter API keys through the [Twitter developer apps dashboard](https://apps.twitter.com/).
* Install Twitter Kit using instructions below.
* For extensive documentation, please see the [wiki](https://github.com/twitter/twitter-kit-android/wiki).
Define via Gradle:
### Install using Bintray JCenter
Add twitter dependency to your build.gradle:
```groovy
repositories {
......@@ -22,20 +33,11 @@ dependencies {
```
## Getting Started
### Building from source
* Create your Twitter app through [this portal](https://apps.twitter.com/).
* Rename samples/app/twitter.properties.sample to samples/app/twitter.properties and populate the consumer key and secret.
* Run Sample app to verify build.
* For extensive documentation, please see the [official documentation](http://dev.twitter.com/twitterkit/overview.html).
Rename samples/app/twitter.properties.sample to samples/app/twitter.properties and populate the consumer key and secret.
## Code of Conduct
This, and all github.com/twitter projects, are under the [Twitter Open Source Code of Conduct](https://github.com/twitter/code-of-conduct/blob/master/code-of-conduct.md). Additionally, see the [Typelevel Code of Conduct](http://typelevel.org/conduct) for specific examples of harassing behavior that are not tolerated.
## Building
Please use the provided gradle wrapper to build the project.
To build the entire project run
```
./gradlew assemble
......@@ -44,7 +46,7 @@ Please use the provided gradle wrapper to build the project.
Run all automated tests on device to verify.
```
./gradlew connectedCheck
./gradlew test connectedCheck
```
To run the sample app
......@@ -54,10 +56,14 @@ To run the sample app
```
Contributing
## Contributing
The master branch of this repository contains the latest stable release of Twitter Kit. See [CONTRIBUTING.md](https://github.com/twitter/twitter-kit-android/blob/master/CONTRIBUTING.md) for more details about how to contribute.
## Code of Conduct
This, and all github.com/twitter projects, are under the [Twitter Open Source Code of Conduct](https://github.com/twitter/code-of-conduct/blob/master/code-of-conduct.md). Additionally, see the [Typelevel Code of Conduct](http://typelevel.org/conduct) for specific examples of harassing behavior that are not tolerated.
## Contact
For usage questions post on [Twitter Community](https://twittercommunity.com/tags/c/publisher/twitter/android).
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册