From c0d50fd64dfa9bc5b3d609530232a6d6f7b603f9 Mon Sep 17 00:00:00 2001 From: George Steel Date: Thu, 15 Jul 2021 11:40:18 +0100 Subject: [PATCH] Make the licence a markdown file and add some content to the readme --- LICENSE => LICENSE.md | 2 +- README.md | 17 +++++++++++++++-- 2 files changed, 16 insertions(+), 3 deletions(-) rename LICENSE => LICENSE.md (97%) diff --git a/LICENSE b/LICENSE.md similarity index 97% rename from LICENSE rename to LICENSE.md index 972e76e..2f128d7 100644 --- a/LICENSE +++ b/LICENSE.md @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2020 Net Glue Ltd +Copyright (c) 2021 Net Glue Ltd Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index ac388b7..1b5c2c0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Primo… +A silly contraction on [Prismic](https://prismic.io) and [Mezzio](https://docs.mezzio.dev)! + [![Build Status](https://github.com/netglue/primo/workflows/Continuous%20Integration/badge.svg)](https://github.com/netglue/primo/actions?query=workflow%3A"Continuous+Integration") [![codecov](https://codecov.io/gh/netglue/primo/branch/main/graph/badge.svg)](https://codecov.io/gh/netglue/primo) @@ -8,8 +10,19 @@ [![Latest Stable Version](https://poser.pugx.org/netglue/primo/v/stable)](https://packagist.org/packages/netglue/primo) [![Total Downloads](https://poser.pugx.org/netglue/primo/downloads)](https://packagist.org/packages/netglue/primo) -A silly contraction on [Prismic](https://prismic.io) and [Mezzio](https://docs.mezzio.dev)! This library integrates the Prismic.io headless content management system with Mezzio. -Currently a work in progress so expect BC until it reaches a 1.0 release đŸ˜¬ +If you're building websites in PHP and want a CMS without the hassle of managing databases, then this is worth considering as a solid alternative to the usual suspects. + +For more information, it's worth checking out the "[Primo Skeleton](https://github.com/netglue/primo-skeleton)" app on GitHub and its deployment at [primo.ngio.uk](https://primo.ngio.uk). + +Also, this lib consumes [netglue/prismic-client](https://github.com/netglue/prismic-client) which is what you'll be interacting with most when it comes to actually making some content… + +## Stability + +This library is mainly targeted at not re-inventing the wheel every time you want to build a CMS website using a Prismic content backend. As it's used in a number of production projects, I'm pretty careful with the releases and relatively dilligent with the [CHANGELOG](./CHANGELOG.md) + +## License + +[MIT Licensed](./LICENSE.md).