Merge pull request #1 from census-instrumentation/readme-and-setup

Add base package with lerna, update README

.circleci/config.yml

@@ -0,0 +1,43 @@
+# Javascript Node CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-javascript/ for more details
+#
+
+---
+release_tags: &release_tags
+  tags:
+    only: /^v\d+(\.\d+){2}(-.*)?$/
+
+version: 2.0
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/node:10-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/mongo:3.4.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "package.json" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run: npm install
+
+      - save_cache:
+          paths:
+            - node_modules
+          key: v1-dependencies-{{ checksum "package.json" }}
+
+      # run tests!
+      - run: npm test

.gitignore

@@ -18,5 +18,25 @@ bin
 # Vim
 .swp
 
+#VScode
+.vscode/
+
 # Other
 TAGS
+
+# nodejs
+node_modules/
+!packages/opencensus-nodejs/test/instrumentation/node_modules
+npm-debug.log
+.nyc_output/
+build/
+
+#backup files
+*--
+*_backup
+
+#log files
+*.log
+
+#istanbul files
+coverage/

README.md

@@ -1,10 +1,11 @@
-# OpenCensus - A stats collection and distributed tracing framework
+# OpenCensus for Web Browsers
 [![Gitter chat][gitter-image]][gitter-url]
 
-OpenCensus is a toolkit for collecting application performance and behavior data. It currently 
-includes 3 apis: stats, tracing and tags.
+OpenCensus Web is an experimental implementation of OpenCensus, a toolkit for
+collecting application performance and behavior monitoring data.
 
-The library is in alpha stage and the API is subject to change.
+The library is in an experimental pre-alpha stage and the API is subject to
+change, and is not suitable for production use.
 
 Please join [gitter](https://gitter.im/census-instrumentation/Lobby) for help or feedback on this
 project.

lerna.json

@@ -0,0 +1,7 @@
+{
+  "lerna": "3.8.5",
+  "packages": [
+    "packages/*"
+  ],
+  "version": "0.0.1"
+}