Skip to content
This repository has been archived by the owner on Jun 13, 2022. It is now read-only.

Commit

Permalink
chore(docs): update the first steps instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
juliomrqz committed Nov 17, 2018
1 parent 1841390 commit 4f23aca
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 62 deletions.
27 changes: 1 addition & 26 deletions packages/docs/src/README.md
Expand Up @@ -12,32 +12,7 @@ features:
details: Use the power of blazing-fast Static Site Generation or Server-Side Rendering, so you can easily deploy to a variety of hosting services with no expensive server costs.
---

### Just Easy Steps

``` bash
# install
npm install -g statusfy # OR yarn global add statusfy

# create a base project
statusfy init

# create an incident
statusfy new-incident

# serve the application in development mode
statusfy dev

# generate a static web application
statusfy generate

# build for production and launch server
statusfy build
statusfy start
```

::: warning COMPATIBILITY NOTE
Statusfy requires Node.js >= 8.
:::
<Subscribe />

<!-- Footer Component -->
<Footer />
27 changes: 1 addition & 26 deletions packages/docs/src/es/README.md
Expand Up @@ -12,32 +12,7 @@ features:
details: Usa el poder de la Generación de Sitios Estáticos o la Representación del lado del Servidor, de modo que puede implementarse fácilmente en una variedad de servicios de hospedaje sin costos elevados de servidor.
---

### Solo pasos sencillos

``` bash
# instala
npm install -g statusfy # O yarn global add statusfy

# crea un proyecto base
statusfy init

# crea un incidente
statusfy new-incident

# sirve la aplicación en modo de desarrollo
statusfy dev

# genera una aplicación web estática
statusfy generate

# construye para producción y lanza el servidor
statusfy build
statusfy start
```

::: warning NOTA DE COMPATIBILIDAD
Statusfy requiere Node.js >= 8.
:::
<Subscribe />

<!-- Footer Component -->
<Footer />
10 changes: 5 additions & 5 deletions packages/docs/src/es/guide/getting-started.md
Expand Up @@ -12,17 +12,17 @@ Statusfy requiere Node.js >= 8.

## Instalación

Asegúrate de tener instalado [npx](https://www.npmjs.com/package/npx) (`npx` viene incluido por defecto desde [npm](https://www.npmjs.com/get-npm) `5.2.0`)

``` bash
# cambia el directorio de trabajo
cd existing_folder

# instala globalmente
npm install -g statusfy # O yarn global add statusfy

# ejecuta el comando de inicialización
statusfy init
npx statusfy init

# y responde a las preguntas requeridas
# e instala las dependencias locales
npm install # O yarn install
```

Se generará una estructura básica para tu proyecto. En el archivo `package.json` estarán disponibles estos comandos para el desarrollo y despliegue de tu Sistema de Página de Estado:
Expand Down
10 changes: 5 additions & 5 deletions packages/docs/src/guide/getting-started.md
Expand Up @@ -8,17 +8,17 @@ Statusfy requires Node.js >= 8.

## Installation

Make sure you have [npx](https://www.npmjs.com/package/npx) installed (`npx` is shipped by default since [npm](https://www.npmjs.com/get-npm) `5.2.0`)

``` bash
# change the working directory
cd existing_folder

# install globally
npm install -g statusfy # OR yarn global add statusfy

# run the initialization command
statusfy init
npx statusfy init

# and answer the required questions
# and install your local dependencies
npm install # OR yarn install
```

It will be generated a basic structure for your project. In the `package.json` file will be available these commands for the development and deployment of your Status Page System:
Expand Down

0 comments on commit 4f23aca

Please sign in to comment.