<commit_before>##Lightweight javac @Warning annotation

FAQ:

Q: ***What is @Warning annotation for?***

A: For throwing warning messages from java compiler (javac).

Q: ***When and why can you use it?***

A: When you want to mark some piece of code as "dangerous" or "unstable", etc. (Don't do it often)

Q: ***Why not to use // TODO or FIXME comments, etc?*** 

A: Because they don't throw compile time warnings by default (depends on IDE, settings, etc.)

Q: ***What is the size of the library?*** 

A: About 3kb, only two classes: @Warning annotation and annotation processor.

------------------------------
**Usage is very very simple:**

    // some code...
    
    @Warning("This method should be refactored")
    public void someCodeWhichYouNeedAtTheMomentButYouWantToRefactorItLater() {
        // bad stuff going on here...
    }


Notice, if you use another annotation processors — you may need to exclude 
    
    'META-INF/services/javax.annotation.processing.Processor'
    
For Android Gradle setup in can be done like that:

    build.gradle:
    
    android {
        
        // ...
        
        packagingOptions {
            exclude 'META-INF/services/javax.annotation.processing.Processor'
        }
    }<commit_msg>Added info about maven central, improved markdown<commit_after>##Lightweight javac @Warning annotation

FAQ:

Q: ***What is @Warning annotation for?***

A: For throwing warning messages from java compiler (javac).

Q: ***When and why can you use it?***

A: When you want to mark some piece of code as "dangerous" or "unstable", etc. (Don't do it often)

Q: ***Why not to use // TODO or FIXME comments, etc?*** 

A: Because they don't throw compile time warnings by default (depends on IDE, settings, etc.)

Q: ***What is the size of the library?*** 

A: About 3kb, only two classes: @Warning annotation and annotation processor.

------------------------------
**Usage:**

```java
    // some code...
    
    @Warning("This method should be refactored")
    public void someCodeWhichYouNeedAtTheMomentButYouWantToRefactorItLater() {
        // bad stuff going on here...
    }
```

###Download

Gradle:

```groovy
compile 'com.pushtorefresh:javac-warning-annotation:1.0.0'
```
    // Library doesn't bring anything to the runtime
    // So you can use provided scope instead of compile 

Maven:
```xml
<dependency>
  <groupId>com.pushtorefresh</groupId>
  <artifactId>javac-warning-annotation</artifactId>
  <version>1.0.0</version>
</dependency>
```

Or grab jar directly from [mavenCentral](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.pushtorefresh%22%20AND%20a%3A%22javac-warning-annotation%22)

------------------------------

Notice, if you use another annotation processors — you may need to exclude 
    
    'META-INF/services/javax.annotation.processing.Processor'
    
For Android Gradle setup in can be done like that:

build.gradle:
```groovy    
    android {
        
        // ...
        
        packagingOptions {
            exclude 'META-INF/services/javax.annotation.processing.Processor'
        }
    }
```
{'fraction_non_alphanumeric': 0.13920362576885723, 'fraction_numerical': 0.008416963418582066, 'mean_word_length': 2.819530284301607, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 1}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3886313', 'n_tokens_mistral': 960, 'n_tokens_neox': 890, 'n_words': 318}