Skip to content
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.

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

Make the Usage instrcutions better, currently only in README.md #5

Open
enlighter opened this issue Feb 2, 2018 · 1 comment
Open

Comments

@enlighter
Copy link

FL.init(new FLConfig.Builder(this)
                .logger()          // customise how to hook up with logcat
                .defaultTag()      // customise default tag
                .logToFile(true)   // enable logging to file
                .dir()             // customise directory to hold log files
                .formatter()       // customise log format and file name
                .retentionPolicy() // customise retention strategy
                .maxFileCount()    // customise how many log files to keep if retention by file count
                .maxTotalSize()    // customise how much space log files can occupy if retention by total size
                .build());

is not how one can actually use it, as the logger(), defaultTag() etc. methods require a parameter to be passed, they cannot be run without passing any parameters.

So you should make the instructions clearer and a more detailed. Maybe provide a sample app code.

@bosphere
Copy link
Owner

bosphere commented Feb 6, 2018

thanks for the feedback, will improve it. but i do provide a sample app already under app module, feel free to check it out for more detailed usage. in fact the source code is pretty straightforward, so i didn't bother adding too much documentation. but yeah, you definitely make a good point here. thanks for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants