ShoutOut

Additional

Language
Java
Version
1.0.2 (Jun 27, 2016)
Created
Mar 1, 2016
Updated
Nov 9, 2017
Owner
Nishant Srivastava (nisrulz)
Contributor
Nishant Srivastava (nisrulz)
1
Activity
Badge
Generate
Download
Source code
APK file

Announcement

ShoutOut 

Android library for simplified logging

Built with ❤︎ by Nishant Srivastava and contributors


Including in your project

ShoutOut is available in the Jcenter, so getting it as simple as adding it as a dependency

compile 'com.github.nisrulz:shoutout:{latest version}'

where {latest version} corresponds to published version in

Usage

  • First create and init shoutout;

    ShoutOut shoutOut;
    // Init the ShoutOut Lib
    shoutOut = ShoutOut.withTag(debuggable, TAG);
    
    // or you can also init as below to specify a priority
    shoutOut = ShoutOut.withTagAndPriority(debuggable,TAG, priority);

    where priority can be Log.DEBUG, Log.ERROR, Log.ASSERT, Log.WTF or Log.INFO

  • Now log data as below

    // Debug Logs
    shoutOut.log("This is Debug information here in LOGCAT");
    
    // Error Logs
    shoutOut.withCause(new RuntimeException("Hello! I am Runtime exception"));
  • You can chain an extra debug log to exception log

    shoutOut.log("This is Debug information here that is chained for adding a message to exception stacktrace in LOGCAT")
            .withCause(new RuntimeException("Hello! I am Runtime exception"));

Pull Requests

I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request:

  1. Match coding style (braces, spacing, etc.) This is best achieved using CMD+Option+L (Reformat code) on Mac (not sure for Windows) with Android Studio defaults. The code style used in this project is from Grandcentrix, so please use the same when editing this project.
  2. If its a feature, bugfix, or anything please only change code to what you specify.
  3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
  4. Pull requests must be made against develop branch. Any other branch (unless specified by the maintainers) will get rejected.
  5. Check for existing issues first, before filing an issue.
  6. Have fun!

License

Licensed under the Apache License, Version 2.0, click here for the full license.

Author & support

This project was created by Nishant Srivastava but hopefully developed and maintained by many others. See the the list of contributors here.

If you appreciate my work, consider buying me a cup of ☕️ to keep me recharged 🤘

  • PayPal
  • Bitcoin Address: 13PjuJcfVW2Ad81fawqwLtku4bZLv1AxCL

I love using my work and I'm available for contract work. Freelancing helps to maintain and keep my open source projects up to date!