Skip to content

Commit

Permalink
Added Circle CI and adjust readme to feature Yarn (#355)
Browse files Browse the repository at this point in the history
* Use Circle CI

* Removed Travis CI

* Replaced status badge

* Improved intro
  • Loading branch information
leo authored Apr 22, 2018
1 parent e1a4fb7 commit 3f4116e
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 11 deletions.
26 changes: 26 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
version: 2
jobs:
build:
docker:
- image: circleci/node:latest

working_directory: ~/repo

steps:
- checkout

- restore_cache:
keys:
- v1-dependencies-{{ checksum "package.json" }}
# fallback to using the latest cache if no exact match is found
- v1-dependencies-

- run: yarn

- save_cache:
paths:
- node_modules
key: v1-dependencies-{{ checksum "package.json" }}

- run: yarn test

7 changes: 0 additions & 7 deletions .travis.yml

This file was deleted.

14 changes: 10 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,29 @@
# serve

[![Build Status](https://travis-ci.org/zeit/serve.svg?branch=master)](https://travis-ci.org/zeit/serve)
[![Build Status](https://circleci.com/gh/zeit/serve.svg?&style=shield)](https://circleci.com/gh/zeit/serve)
[![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/micro/serve)

Ever wanted to share a project on your network by running just a command? Then this module is exactly what you're looking for: It provides a neat interface for listing the directory's contents and switching into sub folders.
Have you ever wanted to share a project on your network by running just a command? Then this module is exactly what you're looking for: It provides a neat interface for listing the directory's contents and switching into sub folders.

In addition, it's also awesome when it comes to serving static sites!

![screenshot](https://raw.githubusercontent.com/zeit/art/4bafffc43b38f3b796eb2f9071292d13d129a7d8/serve/example.png)

## Usage

Install it (needs at least Node LTS):
Firstly, install the package from [npm](https://npmjs.com/release) (you'll need at least Node.js 7.6.0):

```bash
npm install -g serve
```

And run this command in your terminal:
Alternatively, you can use [Yarn](https://yarnpkg.com/en/) to install it:

```bash
yarn global add serve
```

Once that's done, you can run this command inside your project's directory:

```bash
serve [options] <path>
Expand Down

0 comments on commit 3f4116e

Please sign in to comment.