add logo and code of conduct (#7)

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

README.md

@@ -1,8 +1,4 @@
-                  _
-            __  _| |_ _ __ __ _  ___ ___
-            \ \/ / __| '__/ _` |/ __/ _ \
-             >  <| |_| | | (_| | (_|  __/
-            /_/\_\\__|_|  \__,_|\___\___|
+![xtrace](https://cdn.rawgit.com/brekk/xtrace/554215b/logo.svg)
 
 > a tool for adding clarity to your compositional-pipelines or just invoking side-effects in a clean way
 
@@ -56,50 +52,6 @@ const verboseConditionalLoggerWhenMultiplyingBy5 = R.pipe(
 
 #### API
 
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-##### sideEffect
-
-`import {sideEffect} from 'xtrace'`
-
-The high-level abstraction for identity-closure side-effects
-
-**Parameters**
-
--   `effect` **[function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** function which does something independent of the returned value
--   `tag` **any** first value to pass to the side effect
--   `inspect` **[function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** function which wraps the second value to pass to the side effect
--   `input` **any** the return value, and the value passed to the inspect function
-
-Returns **any** whatever input is
-
-##### xtrace
-
-`import {xtrace} from 'xtrace'`
-
-xtrace is the same as sideEffect, only we dropped the inspect parameter by passing identity
-
-**Parameters**
-
--   `effect` **[function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** function which does something independent of the returned value
--   `tag` **any** first value to pass to the side effect
--   `input` **any** the return value, and the value passed to the side effect
-
-Returns **any** whatever input is
-
-##### trace
-
-`import {trace} from 'xtrace'`
-
-trace is the same as xtrace, only we applied the first parameter as console.log, for convenience
-
-**Parameters**
-
--   `tag` **any** first value to pass to the console.log
--   `input` **any** the return value, and the value passed to the console.log
-
-Returns **any** whatever input is
-
 #### Similar efforts:
 
 -   `composition-trace` - <https://github.com/stevemao/composition-trace>

package.json

@@ -12,10 +12,10 @@
     "babel": "inherit"
   },
   "nyc": {
-    "statements": 90,
-    "branches": 90,
-    "functions": 90,
-    "lines": 90,
+    "statements": 100,
+    "branches": 100,
+    "functions": 100,
+    "lines": 100,
     "reporter": [
       "lcov",
       "json",

src/trace.js

@@ -1,11 +1,10 @@
-import {curry, PLACEHOLDER as __} from 'katsu-curry'
+import {I as identity, curry, PLACEHOLDER as __} from 'katsu-curry'
 
 export const PLACEHOLDER = __
 export const $ = __
+export const I = identity
 
 /**
- * `import {sideEffect} from 'xtrace'`
- *
  * The high-level abstraction for identity-closure side-effects
  * @method sideEffect
  * @param {function} effect - function which does something independent of the returned value
@@ -14,6 +13,13 @@ export const $ = __
  * @param {*} input - the return value, and the value passed to the inspect function
  * @returns {*} - whatever input is
  * @public
+ * @example
+ * import {sideEffect, $, I} from 'xtrace'
+ * import _debug from 'debug'
+ * const debug = _debug(`my:custom:debugger`)
+ * const trace = sideEffect(debug, $, I, $)
+ * // [...]
+ * trace(`input`, 5) // only logs if DEBUG env var (e.g. DEBUG=my:custom:debugger node this-file.js)
  */
 export const sideEffect = curry(
   function __sideEffect(effect, tag, inspect, input) {
@@ -24,31 +30,33 @@ export const sideEffect = curry(
   }
 )
 
-// istanbul ignore next
-// identity function
-const I = (x) => x
-
 /**
- * `import {xtrace} from 'xtrace'`
- *
  * xtrace is the same as sideEffect, only we dropped the inspect parameter by passing identity
  * @method xtrace
  * @param {function} effect - function which does something independent of the returned value
  * @param {*} tag - first value to pass to the side effect
  * @param {*} input - the return value, and the value passed to the side effect
  * @returns {*} - whatever input is
  * @public
+ * @example
+ * import {xtrace} from 'xtrace'
+ * import _debug from 'debug'
+ * const debug = _debug(`my:custom:debugger`)
+ * const trace = xtrace(debug)
+ * // [...]
+ * trace(`input`, 5) // only logs if DEBUG env var (e.g. DEBUG=my:custom:debugger node this-file.js)
  */
 export const xtrace = sideEffect(__, __, I, __)
 
 /**
- * `import {trace} from 'xtrace'`
- *
  * trace is the same as xtrace, only we applied the first parameter as console.log, for convenience
  * @method trace
  * @param {*} tag - first value to pass to the console.log
  * @param {*} input - the return value, and the value passed to the console.log
  * @returns {*} - whatever input is
  * @public
+ * @example
+ * import {trace} from 'xtrace'
+ * trace(`whatever`, 5) // logs 'whatever', 5
  */
 export const trace = xtrace(console.log) // eslint-disable-line no-console