From f58608c9821e3079d1d2b285f37860bf66220a62 Mon Sep 17 00:00:00 2001 From: Jason Irish Date: Thu, 5 Sep 2024 18:06:34 -0500 Subject: [PATCH] README Initial (#4) --- LICENSE.md | 2 +- README.md | 114 ++++++++++++-------------------------------------- composer.json | 2 +- 3 files changed, 29 insertions(+), 89 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index 1886837..33ac867 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,4 +1,4 @@ -Copyright (c) +Copyright (c) Dynamic, Inc. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: diff --git a/README.md b/README.md index a7c5603..fbadc30 100644 --- a/README.md +++ b/README.md @@ -1,109 +1,49 @@ -# SilverStripe supported module skeleton - -A useful skeleton to more easily create a [Silverstripe Module](https://docs.silverstripe.org/en/4/developer_guides/extending/modules/) that conform to the -[Module Standard](https://docs.silverstripe.org/en/developer_guides/extending/modules/#module-standard). - -This readme contains descriptions of the parts of this module base you should customise to meet you own module needs. -For example, the module name in the H1 above should be you own module name, and the description text you are reading now -is where you should provide a good short explanation of what your module does. - -Where possible we have included default text that can be included as is into your module and indicated in -other places where you need to customise it - -Below is a template of the sections of your readme.md you should ideally include to met the Module Standard -and help others make use of your modules. - -### Steps to prepare this module for your own use: - -- Clone this repository into a folder -- Add your name/organisation to `LICENSE.md` -- Update this readme with information about your module. Ensure sections that aren't relevant are deleted and -placeholders are edited where relevant -- Review the README files in the various provided directories. You should replace these with `.gitkeep` or delete the -directories -- Update the module's `composer.json` with your requirements and package name -- Update (or remove) `package.json` with your requirements and package name. Run `yarn` (or remove `yarn.lock`) to -ensure dependencies resolve correctly -- Clear the git history by running `rm -rf .git && git init` -- Add and push to a VCS repository -- Either [publish](https://getcomposer.org/doc/02-libraries.md#publishing-to-packagist) the module on packagist.org, or add a [custom repository](https://getcomposer.org/doc/02-libraries.md#publishing-to-a-vcs) to your main `composer.json` -- Require the module in your main `composer.json` -- If you need to build a JS client - - Ensure that `vendor/silverstripe/admin` is installed with `composer install --prefer-source` instead of the default `--prefer-dist`. You may need to first remove the module from the vendor folder. - - Install third party dependencies in your module AND in `vendor/silverstripe/admin` by running `yarn install` in both locations -- Start developing your module! +# Silverstripe Locations -## Requirements +A Location DataObject for Silverstripe. Includes the ability to generate coordinates based on an address. -* SilverStripe ^4.0 -* [Yarn](https://yarnpkg.com/lang/en/), [NodeJS](https://nodejs.org/en/) (6.x) and [npm](https://npmjs.com) (for building - frontend assets) -* Other module -* Other server requirement -* Etc +![CI](https://github.com/dynamic/silverstripe-locations/workflows/CI/badge.svg) +[![codecov](https://codecov.io/gh/dynamic/silverstripe-locations/branch/master/graph/badge.svg)](https://codecov.io/gh/dynamic/silverstripe-locations) -## Installation -Add some installation instructions here, having a 1 line composer copy and paste is useful. -Here is a composer command to create a new module project. Ensure you read the -['publishing a module'](https://docs.silverstripe.org/en/developer_guides/extending/how_tos/publish_a_module/) guide -and update your module's composer.json to designate your code as a SilverStripe module. +[![Latest Stable Version](https://poser.pugx.org/dynamic/silverstripe-locations/v/stable)](https://packagist.org/packages/dynamic/silverstripe-locations) +[![Total Downloads](https://poser.pugx.org/dynamic/silverstripe-locations/downloads)](https://packagist.org/packages/dynamic/silverstripe-locations) +[![Latest Unstable Version](https://poser.pugx.org/dynamic/silverstripe-locations/v/unstable)](https://packagist.org/packages/dynamic/silverstripe-locations) +[![License](https://poser.pugx.org/dynamic/silverstripe-locations/license)](https://packagist.org/packages/dynamic/silverstripe-locations) -``` -composer require silverstripe-module/skeleton 4.x-dev -``` +## Requirements -**Note:** When you have completed your module, submit it to Packagist or add it as a VCS repository to your -project's composer.json, pointing to the private repository URL. +* silverstripe/recipe-cms: ^5.0 +* silverstripe/linkfield: ^4.0 -## License -See [License](license.md) - -We have included a 3-clause BSD license you can use as a default. We advocate for the BSD license as -it is one of the most permissive and open licenses. +## Installation -Feel free to alter the [license.md](license.md) to suit if you wan to use an alternative license. -You can use [choosealicense.com](http://choosealicense.com) to help pick a suitable license for your project. +`composer require dynamic/silverstripe-locations` -## Documentation - * [Documentation readme](docs/en/readme.md) +## License -Add links into your docs/ folder here unless your module only requires minimal documentation -in that case, add here and remove the docs folder. You might use this as a quick table of content if you -mhave multiple documentation pages. +See [License](LICENSE.md) -## Example configuration (optional) -If your module makes use of the config API in SilverStripe it's a good idea to provide an example config - here that will get the module working out of the box and expose the user to the possible configuration options. +## Usage -Provide a yaml code example where possible. +Use the Locations Admin to create Location records. -```yaml +## Maintainers -Page: - config_option: true - another_config: - - item1 - - item2 - -``` + * [Dynamic](https://www.dynamicagency.com) () -## Maintainers - * Person here - * Another maintainer - ## Bugtracker -Bugs are tracked in the issues section of this repository. Before submitting an issue please read over -existing issues to ensure yours is unique. - +Bugs are tracked in the issues section of this repository. Before submitting an issue please read over +existing issues to ensure yours is unique. + If the issue does look like a new bug: - + - Create a new issue - - Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots + - Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots and screencasts can help here. - - Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version, + - Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version, Operating System, any installed SilverStripe modules. - + Please report security issues to the module maintainers directly. Please don't file security issues in the bugtracker. - + ## Development and contribution If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers. diff --git a/composer.json b/composer.json index 3e608ac..d27d959 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "dynamic/silverstripe-locations", - "description": "A locations module for silverstripe.", + "description": "A Location DataObject for Silverstripe. Includes the ability to generate coordinates based on an address.", "license": "BSD-3-Clause", "type": "silverstripe-vendormodule", "keywords": [