Skip to content

Commit

Permalink
updated readme and doc for v.0.1.4.
Browse files Browse the repository at this point in the history
  • Loading branch information
ikramagix committed Oct 27, 2024
1 parent d1ddb64 commit 42f8eca
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 7 deletions.
28 changes: 28 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,31 @@
## [0.1.1] - 2024-09-28

- First live version

## [0.1.4] - 2024-10-27

## [Unreleased]

## [0.1.0] - 2023-12-25
- Initial release

## [RELEASED]

## [0.1.1] - 2024-09-28
- First live version

## [0.1.4] - 2024-10-27
### Added
- **New `Faussaire::Piraterie` Methods**:
- `role`: Generates a learner status inspired by The Hacking Project.
- `pnj`: Provides a pirate-themed character title.
- `nav`: Outputs a random pirate ship type.
- `rage`: Produces pirate-themed swearing expressions.
- `excuse`: Generates excuses for project delays or absences.
- `potin`: Creates gossipy anecdotes about bootcamp life.

### Enhancements
- Improved spec coverage:
- Tests for duplicate values in YAML data.
- Format validation for data entries.
- Tests to confirm that each method returns a unique and expected value.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -330,32 +330,32 @@ Faussaire::Name.name
<details>
<summary><strong>Faussaire::Piraterie</strong></summary>

Le module `Faussaire::Piraterie` est un hommage à The Hacking Project, le bootcamp français qui réinvente l'apprentissage du code grâce à l'entraide et à l'esprit d'équipe. Ce module permet de générer des données inspirés de l'univers de la formation.
Le module `Faussaire::Piraterie` est un hommage à The Hacking Project (THP), le bootcamp français qui réinvente l'apprentissage du code grâce à l'entraide et à l'esprit d'équipe. Ce module permet de générer des données inspirés de l'univers de la formation et a été réalisé pour être utilisé dans le cadre de la formation.

```ruby
# Génère un rôle qu'un apprenant peut avoir chez The Hacking Project.
# Génère un rôle qu'un apprenant peut avoir chez THP.
Faussaire::Piraterie.role
# => "Moussaillon"

# Génère un statut thématique autour de la piraterie mais qui n'est pas ().
# Génère un statut thématique autour de la piraterie mais qui n'est pas (encore) utilisé chez THP.
Faussaire::Piraterie.pnj
# => "Siresse"

# Génère un type de navire pirate.
Faussaire::Piraterie.nav
# => "Frégate"

# Génère un juron de marin pour ajouter du caractère à un texte.
# Génère un juron de pirate.
Faussaire::Piraterie.rage
# => "Mille millions de mille sabords !"

# Génère une excuse aléatoire pour justifier une absence ou un retard.
# Génère une excuse aléatoire pour justifier une absence, un retard ou un projet non rendu.
Faussaire::Piraterie.excuse
# => "Les embruns de la mer de Frêche m'ont rendu un peu fébrile… ai-je droit à un peu de repos Capitaine ?"

# Génère un potin amusant sur l'expérience d'apprentissage à THP.
# Génère un potin amusant sur l'expérience d'apprentissage à THP, idéal pour le fameux Gossip Project.
Faussaire::Piraterie.potin
# => "Il paraît qu’un moussaillon préfère naviguer en eaux troubles avec des commits non testés !"
# => "“Une bête de prime en crypto” : un corsaire influent promet une récompense au premier moussaillon qui contribue à la gem Faussaire. Des bruits de ponton racontent qu'un corsaire influent de la promo aurait mis en jeu une prime en crypto pour inciter les moussaillons à contribuer à la célèbre gem Faussaire. Vrai bonne affaire ou simple manigance ?"
```
</details>

Expand Down

0 comments on commit 42f8eca

Please sign in to comment.