2017 © Pedro Peláez
 

application hints

Knowledge sharing made easy

image

varavan/hints

Knowledge sharing made easy

  • Tuesday, December 13, 2016
  • by varavan
  • Repository
  • 1 Watchers
  • 3 Stars
  • 18 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 15 Versions
  • 0 % Grown

The README.md

Hints

Microlearning tool for sharing knowledge on php projects, no mather how complex is the project. Have you ever found yourself trying to fix something for ages, then someone else tell you an small hint that makes you resolve it within minutes? That is the purpose for of this project. To have a set of hints that can be easily add or shown from your terminal., (*1)

Example

show random hint show random hint, (*2)

show hint related to some code show hint related to some code, (*3)

adding a new hint adding new hints, (*4)

Installation

Install it via composer with composer require varavan/hints, (*5)

Usage

There is an entry point for the application which is the file hints. After the installation you can call it via vendor/varavan/hints/hints As long as this project is thought to be implemented on php projects, the app is written on php., (*6)

I would encourage you to create a symlink between the executable file hints and your bin folder. So it is easier to include hints on your project, (*7)

I would advice you to call hints command on composer post-scripts, so everyone can refresh thoose knowleage pills on every vendor updates, (*8)

Please notice that the storage for this application is a file called hints.json that will be versioned, (*9)

adding hints hints add 'content of the hint' - option to add some author metadata --author 'AUTHOR NAME' - option to add some tags as metadata --tags 'ADD TAGS SEPARATE BY COMMA' - option to point a file --file-path 'FILE_PATH_FOR_CONTENT_RELATED' - option to point a line --file-line 'FILE_LINE', (*10)

listing hints hints show - option to filter by tags --tags 'tag' - option to filter by author --author - option to filter by file --file-path - option to set up a limit (by default 1) --limit, (*11)

For example hints show --author 'Jhon Doe' --tags 'set-up,init' --limit 15, (*12)

Status

This library is still on development. You can find some bugs and errors on it. Please report it :), (*13)

The Versions

13/12 2016

dev-master

9999999-dev

Knowledge sharing made easy

  Sources   Download

The Requires

 

The Development Requires

by Ivan Ruiz

12/12 2016
01/11 2016

v0.5

0.5.0.0

Sharing knowledge made easy

  Sources   Download

The Requires

 

by Ivan Ruiz

01/11 2016

v0.4

0.4.0.0

Sharing knowledge made easy

  Sources   Download

The Requires

 

by Ivan Ruiz

31/10 2016

v0.3

0.3.0.0

Sharing knowledge made easy

  Sources   Download

The Requires

 

by Ivan Ruiz

31/10 2016

v0.2

0.2.0.0

Sharing knowledge made easy

  Sources   Download

The Requires

 

by Ivan Ruiz

31/10 2016

v0.1

0.1.0.0

Sharing knowledge made easy

  Sources   Download

The Requires

 

by Ivan Ruiz