Add a base Readme. Many details cannot be filled out in at the moment but we can setup the structure so it'll be easier to add notes as we add functionality.

Make sure to add all required sections from the Drupal standards.

Comments

DerekCresswell created an issue. See original summary.

derekcresswell’s picture

Status: Active » Needs review
StatusFileSize
new2.13 KB
joshmiller’s picture

Status: Needs review » Needs work
  1. +++ b/Readme.md
    @@ -0,0 +1,56 @@
    +Content types may be specified so that once a new piece of that content is published it will be sent out to subscribed users. This can be in the format of a stand-alone post or bundled together as a digest of new posts.
    

    Need to change with the views concept.

  2. +++ b/Readme.md
    @@ -0,0 +1,56 @@
    +Visit the [project page](https://www.drupal.org/project/digest) for more information.
    

    "for more information" should be something more like "to post issues or review patches" ... this readme is likely the biggest source of "information"

  3. +++ b/Readme.md
    @@ -0,0 +1,56 @@
    +No special requirements.
    

    Requires Views, an outgoing email service, the SwiftMailer module, and multiple views that filters content as needed.

  4. +++ b/Readme.md
    @@ -0,0 +1,56 @@
    +1. Copy the files of this module into the appropriate folder (`modules/contrib` usually).
    

    Remove this. We only support "composer" based installation.

  5. +++ b/Readme.md
    @@ -0,0 +1,56 @@
    +	A leading ecommerce service provider, giving the insights & development online retailers need to optimize their technology for scalable growth and innovation.
    

    I recommend changing the format of this to look like:

    * Acro
      - Text description
    
derekcresswell’s picture

Status: Needs work » Needs review
StatusFileSize
new2.12 KB

I was being rather literal with things like the requirements and that they'd be modified as we develop the module : )

joshmiller’s picture

Status: Needs review » Reviewed & tested by the community

derekcresswell’s picture

Status: Reviewed & tested by the community » Fixed

Commited, thanks.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.