diff --git a/index.html b/index.html index 0d912ff..453b659 100644 --- a/index.html +++ b/index.html @@ -192,6 +192,10 @@

The axes of Semantic Release Notes

Additionally the release note should be able to indicate what category an item is. For instance, "+New", "+Change", "+Bug-Fix", +Developer". This is indicated via a single word, or - (dash) delimited phrase, that has a "+" prefix. +
  • + Metadata: + A list of metadata can be added to a release note. Only some elements are possible, with their respective specific syntax. +
  • Release: As SRN allows for many releases to be defined within the one block of text, the system needs @@ -313,7 +317,35 @@

    Category

    
                          
    -            
    +
    +                    

    Metadata

    +

    + It can be useful to add some metadata to a release note, for example the list of commits targeted by the release note. +

    +

    + All metadata can be preceded by its name (case insensitive) followed by a colon, but each supported metadata have it's own syntax: +

    +

    +
    + Examples: +
    56af25a...d3fead4
    +Commits: [56af25a...d3fead4](https://github.com/Glimpse/Semantic-Release-Notes/compare/56af25a...d3fead4)
    +Contributors: Jérémie Bertrand, Jake Ginnivan, [Anthony van der Hoorn](https://github.com/avanderhoorn)
    +source: [MyPackage.zip](https://github.com/laedit/MyPackage/archive/v0.1.0.zip)
    +binaries: [MyPackage.exe](https://github.com/laedit/MyPackage/releases/download/v0.1.0/MyPackage.exe)
    +Generated at: 2015-05-04T08:45:36Z
    +2015-05-04T08:45:36Z
    +                        
    +
    +
    
    +                    
    +

    Release (Not Working)

    In some cases we want to have the one document that describes many releases. In this case, the @@ -378,7 +410,7 @@

    Release (Not Working)

    - +

    Examples

      @@ -455,7 +487,9 @@

      Examples

      # Plugin [[icon][http://getglimpse.com/release/icon/mvc.png]] This description is specific to plugin section. 1. *Timeline*: Comes with an additional grid view to show the same data. +Changed - 1. *Ajax*: Fix that crashed poll in Chrome and IE due to log/trace statement. +Fix [[i1234][http://getglimpse.com]] + 1. *Ajax*: Fix that crashed poll in Chrome and IE due to log/trace statement. +Fix [[i1234][http://getglimpse.com]] + +Commits: [56af25a...d3fead4](https://github.com/Glimpse/Semantic-Release-Notes/compare/56af25a...d3fead4) Result:
      Object: @@ -518,14 +552,14 @@

      Tools

    - +