Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
variiance committed Dec 5, 2018
1 parent 5cb8f2d commit e5264c5
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Expand Up @@ -13,21 +13,27 @@ Respresso currently supports five types of resources:

# Installation
You can install Respresso with Homebrew using the following command:
```$ brew install respresso```
```bash
$ brew install respresso
```

# Usage
Using Respresso should be intuitive to anyone who has used Cocoapods before.
Configurations are stored in the respressofile, while your current assets’ metadata are stored in respressofile.lock.
Navigate to your project folder in Terminal, and type
```$ respresso init```
```bash
$ respresso init
```
to initialize a new Respressofile.

![Respressofile with custom host requesting four ot ouf five resource categories](/images/respressofile.png)
*Respressofile with custom host requesting four ot ouf five resource categories*


Once you have configured your Respressofile, type
```$ respresso update```
```bash
$ respresso update
```
to import all requested resources into your project.

## Breakdown of the respressofile
Expand Down Expand Up @@ -55,7 +61,9 @@ By omitting this argument Respresso will use its default host URL for syncing.

## Available Commands
Open terminal and navigate to your project folder. Use any of the commands below by typing
```$ respresso [command]```
```bash
$ respresso [command]
```

##### Init
Initializes a new Respressofile with an empty project token and a resource line commented out.
Expand All @@ -75,7 +83,9 @@ Removes your lock file and all assets associated with Respresso.


Enabling strict mode will guarantee you get the same results each time you sync your assets. If set to true, you may only specify exact version numbers in your Respressofile. This option is set to false by default. Usage example:
```$ respresso update -strict-mode```
```bash
$ respresso update -strict-mode
```

# Licence
```
Expand Down

0 comments on commit e5264c5

Please sign in to comment.