diff --git a/README.md b/README.md index 44b64f9..6b0c2a7 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,12 @@ code from external modules into Power Query. - A collection of general purpose [functions and queries][modules] - Compatibility with [@tycho01's library][tycho01] -Introductory overview is available at [my blog][intro]. -[Documentation][docs] describes some more specific use cases. +### More information + +- Introductory overview is available at [author's blog][intro] +- [Documentation][docs] describes some more specific use cases +- [Release notes](RELEASES.md) contain important information on latest LibPQ changes +- [Roadmap](ROADMAP.md) describes project vision and plans for the future [intro]: https://potyarkin.ml/posts/2018/expanding-power-query-standard-library-introducing-libpq/ [tycho01]: https://github.com/tycho01/pquery diff --git a/RELEASES.md b/RELEASES.md new file mode 100644 index 0000000..90b672c --- /dev/null +++ b/RELEASES.md @@ -0,0 +1,39 @@ +# LibPQ release history + +LibPQ is a library for importing Power Query M language source files from local +and/or web storage. The project follows [semantic versioning](https://semver.org/) +specification. + +This document describes the changes between releases of LibPQ. [Keeping a +changelog](http://keepachangelog.com) is important! + + + +## Version 1.0.0 (2018-02-21) + +#### Git commit: `#n/a` + +This is the first release of LibPQ. The library and the loader are considered +feature full and stable. + +Most of the features are described in the [README](README.md) and in +[documentation][docs]. Introductory overview is available at [author's +blog][intro]. + + +#### New features +- Import source code from plain text files located on disk or on the web +- Unlimited number of import locations ordered by priority +- [Unit testing][unittesting] framework +- Show [docstrings] in Power Query user interface +- A collection of general purpose [functions and queries][modules] +- Compatibility with [@tycho01's library][tycho01] + +[docs]: Docs/README.md +[docstrings]: Docs/Docstrings.md +[intro]: https://potyarkin.ml/posts/2018/expanding-power-query-standard-library-introducing-libpq/ +[modules]: Docs/Modules.md +[tycho01]: https://github.com/tycho01/pquery +[unittesting]: Docs/UnitTesting.md diff --git a/ROADMAP.md b/ROADMAP.md new file mode 100644 index 0000000..9da7980 --- /dev/null +++ b/ROADMAP.md @@ -0,0 +1,42 @@ +# Plans and ideas for LibPQ development + + +## Project vision and values + +LibPQ project was created to enable importing Power Query M language source +code from plain text files located on file system or on the remote web server. +As of version 1.0.0 that goal is achieved, but LibPQ development continues. + +Current goals and values (in order of descending importance) are: +- **Maintaining LibPQ loader**. This is the core functionality of LibPQ and it + must remain fully operational in future versions of Power Query / PowerBI. +- **Ensuring backwards compatibility**. LibPQ is there for other developers to + use, and we should not interfere with the code they've built upon ours. This + applies most strictly to the loader and the modules essential for internal + use (e.g. UnitTest framework), other modules may see some breaking changes in + future (that must always be documented in [release notes](RELEASES.md) and + must be reflected in the release [version number](https://semver.org/)). +- **Improving import-time user experience**. LibPQ already offers local module + listing, parses module docstrings for viewing in the UI and correctly relays + errors in modules' code, but there must be other methods to improve module + discoverability and simplify their usage. If such methods are to be found, + their implementation will be added to LibPQ development roadmap. +- **Extending the collection of useful modules**. LibPQ allows anyone to start + their own library of pre-recorded functions and queries. That library can be + easily incorporated into any other workbook or report that uses LibPQ. That's + why extending the collection of modules and functions that's packaged with + LibPQ has the lowest priority. Only the most widely useful modules that solve + the most general problems will be added to the Modules/ directory. + Domain-specific collections of functions and queries are better suited for a + separate project that relies on LibPQ for importing the source code. + + +## Roadmap to the next release (probably 1.1.0) + +There are no explicit plans for new features yet. This section will be futher +updated in the development process. + +If no critical bugs are discovered and no breaking changes arrive with Power +Query updates, the next (minor) release is scheduled for the Summer of 2018. +Most likely it will contain some additions to the collection of modules and +some minor polishing touches to the import-time user experience. diff --git a/TODO.md b/TODO.md deleted file mode 100644 index c6c9288..0000000 --- a/TODO.md +++ /dev/null @@ -1 +0,0 @@ -# LibPQ TODO list diff --git a/UNITTESTING.md b/UNITTESTING.md deleted file mode 100644 index ef187c2..0000000 --- a/UNITTESTING.md +++ /dev/null @@ -1 +0,0 @@ -Permanently moved to [Docs/UnitTesting.md](Docs/UnitTesting.md)