Pluto Shared Preferences Plugin

Pluto Shared Preferences is a Pluto plugin to inspect and manage Shared Preferences for your Android Application. It comes with a UI to manage and share the information on-the-go.

🖇 Integrate plugin in your application

Add Gradle Dependencies

Pluto Shared Preferences is distributed through mavenCentral. To use it, you need to add the following Gradle dependency to your build.gradle file of you android app module.

dependencies {
  debugImplementation 'com.plutolib.plugins:preferences:1.1.8-alpha'
}

Install plugin to Pluto

Now to start using Pluto Shared Preferences, install the plugin to Pluto

Pluto.Installer(this)
  .addPlugin(PlutoSharePreferencesPlugin("sharedPref"))
  .install()

🎉 You are all done!

Now re-build and run your app and open Pluto, you will see the Pluto Shared Preferences plugin installed.

📝 Contribution

We’re looking for contributors, help us improve Pluto. 😁

Hers’s how you can help

  • Look for issues marked as help wanted
  • While submitting a new PR, make sure tests are all successful. If you think we need any new test, feel free to add new tests.

Prerequisite

In order to start working on Pluto, you need to fork the project and open it in Android Studio/IntelliJ IDEA.

Before committing we suggest you install the pre-commit hooks with the following command:

./gradlew installGitHook

This will make sure your code is validated against ktLint and detekt before every commit.
The command will run automatically before the clean task, so you should have the pre-commit hook installed by then.

Before submitting a PR please run:

./gradlew build

This will build the library and make sure your CI checks will pass.

📃 License

Copyright 2021 Plutolib.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

GitHub

View Github