Skip to content

Commit

Permalink
Merge pull request #12 from fuhrmanator/master
Browse files Browse the repository at this point in the history
Minor text improvements
  • Loading branch information
jecisc committed May 28, 2019
2 parents e279a10 + a6ea8c5 commit 25b41de
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Build Status](https://travis-ci.org/jecisc/TinyLogger.svg?branch=master)](https://travis-ci.org/jecisc/TinyLogger) [![Coverage Status](https://coveralls.io/repos/github/jecisc/TinyLogger/badge.svg)](https://coveralls.io/github/jecisc/TinyLogger)

A really small logger for Pharo application.
A really small logger for Pharo applications.

- [Installation](#installation)
- [Documentation](#documentation)
Expand All @@ -12,7 +12,7 @@ A really small logger for Pharo application.

## Installation

To install TinyLogger on your Pharo image you can just execute the following script:
To install TinyLogger on your Pharo image, execute the following script:

```Smalltalk
Metacello new
Expand All @@ -21,31 +21,31 @@ Metacello new
load
```

To add TinyLogger to your baseline just add this:
To add TinyLogger to your baseline:

```Smalltalk
spec
baseline: 'TinyLogger'
with: [ spec repository: 'github://jecisc/TinyLogger:v1.x.x/src' ]
```

Note that you can replace the #master by another branch as #development or a tag as #v1.0.0, #v1.? or #v1.2.? .
Note you can replace the #master by another branch such as #development or a tag such as #v1.0.0, #v1.? or #v1.2.? .

## Documentation

You can find documentation following those links:
Documentation is split into separate links as follows:
* [User documentation](documentation/UserGuide.md)
* [Developer documentation](documentation/DevelopmentGuide.md)

## Version management

This project use semantic versionning to define the releases. This mean that each stable release of the project will get associate a version number of the form `vX.Y.Z`.
This project use semantic versioning to define the releases. This means that each stable release of the project will be assigned a version number of the form `vX.Y.Z`.

- **X** define the major version number
- **Y** define the minor version number
- **Z** define the patch version number
- **X** defines the major version number
- **Y** defines the minor version number
- **Z** defines the patch version number

When a release contains only bug fixes, the patch number increase. When the release contains new features backward compatibles, the minor version increase. When the release contains breaking changes, the major version increase.
When a release contains only bug fixes, the patch number increases. When the release contains new features that are backward compatible, the minor version increases. When the release contains breaking changes, the major version increases.

Thus, it should be safe to depend on a fixed major version and moving minor version of this project.

Expand All @@ -57,4 +57,4 @@ Thus, it should be safe to depend on a fixed major version and moving minor vers

## Contact

If you have any question or problem do not hesitate to open an issue or contact cyril (a) ferlicot.me
If you have any questions or problems do not hesitate to open an issue or contact cyril (a) ferlicot.me

0 comments on commit 25b41de

Please sign in to comment.