Skip to content

Commit

Permalink
Renamed project
Browse files Browse the repository at this point in the history
  • Loading branch information
leo committed Sep 29, 2016
1 parent 059b880 commit 3a8f705
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
12 changes: 6 additions & 6 deletions README.md
@@ -1,12 +1,12 @@
# micro-list
# list

[![Build Status](https://travis-ci.org/zeit/micro-list.svg?branch=master)](https://travis-ci.org/zeit/micro-list)
[![Build Status](https://travis-ci.org/zeit/list.svg?branch=master)](https://travis-ci.org/zeit/list)
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
[![Slack Channel](https://zeit-slackin.now.sh/badge.svg)](https://zeit.chat/)

Ever wanted to share a certain directory 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. If a directory contains an `index.html`, micro-list will automatically render it instead of serving the file's content as plaintext.
In addition, it's also awesome when it comes to serving static sites. If a directory contains an `index.html`, list will automatically render it instead of serving the file's content as plaintext.

Powers [now-serve](https://github.com/zeit/now-serve).

Expand All @@ -17,7 +17,7 @@ Powers [now-serve](https://github.com/zeit/now-serve).
Install it (needs at least node v6)

```bash
$ npm install -g micro-list
$ npm install -g list
```

Run it
Expand All @@ -33,7 +33,7 @@ You can find a list of all options [below](#options).
| Usage | Description | Default value |
| ---------------------- | ----------- | ------------------ |
| -h, --help | Output all available options | - |
| -v, --version | The version tag of the micro-list instance on your device | - |
| -v, --version | The version tag of the list instance on your device | - |
| -p, --port [port] | A custom port on which the app will be running | 3000 |
| -c, --cache [seconds] | How long static files should be cached in the browser | 3600 |
| -s, --single | Serve single page apps with only one `index.html` in the root directory | - |
Expand All @@ -42,7 +42,7 @@ You can find a list of all options [below](#options).
## Contribute

1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device
2. Uninstall now-serve if it's already installed: `npm uninstall -g micro-list`
2. Uninstall now-serve if it's already installed: `npm uninstall -g list`
3. Link it to the global module directory: `npm link`
4. Transpile the source code and watch for changes: `npm start`

Expand Down
8 changes: 4 additions & 4 deletions package.json
@@ -1,5 +1,5 @@
{
"name": "micro-list",
"name": "list",
"version": "0.8.0",
"description": "Single-command HTTP directory listing and file serving",
"scripts": {
Expand All @@ -11,7 +11,7 @@
"dist",
"views"
],
"repository": "zeit/micro-list",
"repository": "zeit/list",
"bin": {
"list": "dist/bin/list"
},
Expand Down Expand Up @@ -41,9 +41,9 @@
"author": "leo",
"license": "MIT",
"bugs": {
"url": "https://github.com/zeit/micro-list/issues"
"url": "https://github.com/zeit/list/issues"
},
"homepage": "https://github.com/zeit/micro-list#readme",
"homepage": "https://github.com/zeit/list#readme",
"devDependencies": {
"babel-plugin-transform-async-to-generator": "6.16.0",
"babel-plugin-transform-es2015-modules-commonjs": "^6.11.5",
Expand Down
2 changes: 1 addition & 1 deletion views/index.hbs
Expand Up @@ -31,7 +31,7 @@
</main>

<aside>
<p>Node.js {{nodeVersion}} <a href="https://github.com/zeit/micro-list" target="_blank">micro-list</a> running @ localhost:{{port}}</p>
<p>Node.js {{nodeVersion}} <a href="https://github.com/zeit/list" target="_blank">list</a> running @ localhost:{{port}}</p>
</aside>
</body>
</html>

0 comments on commit 3a8f705

Please sign in to comment.