gplugin/gplugin

Add the wiki's index page as our new README.md
bugfix/docs-cleanup
2019-08-12, Gary Kramlich
c9527b45485a
Parents 25f45174de5b
Children d9e0dee13da2
Add the wiki's index page as our new README.md
  • +30 -0
    README.md
  • --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/README.md Mon Aug 12 23:12:31 2019 -0500
    @@ -0,0 +1,30 @@
    +# GPlugin
    +
    +GPlugin is a GObject based library that implements a reusable plugin system.
    +It supports loading plugins in multiple other languages via loaders. It relies
    +heavily on [GObjectIntrospection](https://wiki.gnome.org/GObjectIntrospection)
    +to expose its API to the other languages.
    +
    +It has a simple API which makes it very easy to use in your application.
    +For more information on using GPlugin in your application, please see the
    +[embedding](Embedding) page.
    +
    +## Build Status
    +Default: [![Default Build Status](https://bamboo.pidgin.im/plugins/servlet/wittified/build-status/GPLUG-GPLUGIN)](https://bamboo.pidgin.im/browse/GPLUG-GPLUGIN)
    +Develop: [![Develop Build Status](https://bamboo.pidgin.im/plugins/servlet/wittified/build-status/GPLUG-GPLUGIN0)](https://bamboo.pidgin.im/browse/GPLUG-GPLUGIN0/)
    +
    +## History
    +
    +GPlugin has a bit of history, you can read more about it in [HISTORY.md](HISTORY.md)
    +
    +## Language Support
    +
    +GPlugin currently supports plugins written in C/C++, Lua, Python, and Vala.
    +
    +## API Reference
    +
    +The API reference can the default branch can be found at
    +[docs.pidgin.im/gplugin/default](https://docs.pidgin.im/gplugin/default).
    +
    +The in development API reference for the develop branch can be found at
    +[docs.pidgin.im/gplugin/develop](https://docs.pidgin.im/gplugin/develop).