mirrors/Scribe.js
1
0
Fork 1
mirror of https://github.com/mathew-kurian/Scribe.js synced 2025-04-25 06:45:10 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
Mathew Kurian 2014-08-01 02:40:27 -05:00
parent d9b0e8825f
commit d34b9b003f
1 changed files with 7 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -32,33 +32,13 @@ How to use Scribe.js
======= =======
Using Sribe is as simple as putting the contents of the Scribe folder into your root NodeJS folder. Note: What I am about to show you is the simplest way to use Scribe.js. Since this library (if you can even call it that), is not insave at all, and it should be very easy to adjust to your liking. Using Sribe is as simple as putting the contents of the Scribe folder into your root NodeJS folder. Note: What I am about to show you is the simplest way to use Scribe.js. Since this library (if you can even call it that), is not insave at all, and it should be very easy to adjust to your liking.
1. Make a Scribe directory Installation
---- =======
``` ```
\root npm install git+https://github.com/bluejamesbond/Scribe.js.git
\node_modules
\scribe <--- Make a folder named "scribe"
\views
\controllers
\bunchOfOtherFolder...
app.js
``` ```
2. Add Scribe into this folder Documentation
---- =======
```
\node_modules\scribe <--- Copy the contents of this repo into that folder
```
4. Install the required modules
----
```bat
npm install colors
npm install moment
npm install mkdirp
npm install callsite
npm install express // if you want to enable the visual web view
```
5. Logging with Scribe
----
```js ```js
var scribe = require('scribe'); var scribe = require('scribe');
@ -139,8 +119,8 @@ console.log("Your message"); // [invokedFrom.js:25]
})(console.t('scoped-tag')); })(console.t('scoped-tag'));
``` ```
6. Experimental Experimental
---- =======
```js ```js
// Simple Testing // Simple Testing
// -------------- // --------------