Skip to content

Commit 04ed022

Browse files
committed
#11 Update readme to fix broken image in serverless plugin page
1 parent 46396b6 commit 04ed022

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<h1><img height="75" src="https://user-images.githubusercontent.com/20145075/86084483-aa2d4b80-baba-11ea-938d-53d6b7e37896.png" alt="iOS resume application project app icon"></h1>
1+
<h1><img height="75" src="https://navarasu.github.io/serverless-ruby-layer/assets/serverless-ruby-layer.png" alt="Serverless Ruby Layer"></h1>
22

33
[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com) [![npm](https://img.shields.io/npm/v/serverless-ruby-layer.svg)](https://www.npmjs.com/package/serverless-ruby-layer) [![Build Status](https://img.shields.io/circleci/build/github/navarasu/serverless-ruby-layer)](https://circleci.com/gh/navarasu/serverless-ruby-layer) [![Coverage Status](https://coveralls.io/repos/github/navarasu/serverless-ruby-layer/badge.svg?branch=master)](https://coveralls.io/github/navarasu/serverless-ruby-layer?branch=master) [![MIT License](https://img.shields.io/npm/l/serverless-ruby-layer)](https://github.com/navarasu/serverless-ruby-layer/blob/master/LICENSE)
44

@@ -8,13 +8,15 @@ It auto configures the lamda layer and RUBY_PATH to the all the functions.
88

99
## Install
1010

11-
```shell
12-
npm install serverless-ruby-layer
1311
```
12+
sls plugin install -n serverless-ruby-layer
13+
```
14+
15+
*This will add the plugin to `package.json` and the plugins section of `serverless.yml`.*
1416

1517
## Simple Usage
1618

17-
*Include plugin in the `serverless.yml`*
19+
*`serverless.yml`*
1820

1921
```YML
2022
service: basic
@@ -31,7 +33,7 @@ functions:
3133
handler: handler.hello
3234
```
3335
34-
*Gemfile*
36+
*`Gemfile`*
3537

3638
```ruby
3739
source 'https://rubygems.org'
@@ -40,11 +42,13 @@ functions:
4042

4143
Running `servleress deploy` automatically deploys the required gems as in Gemfile to AWS lambda layer and make the gems available to the `RUBY_PATH` of the functions `hello.handler`
4244

45+
Refer [here](https://github.com/navarasu/serverless-ruby-layer/blob/master/examples/basic) for example.
46+
4347
## Customization
4448

4549
### Using docker for gems with OS specific C extentions
4650

47-
*Add custom config in `serverless.yml`*
51+
*`serverless.yml`*
4852

4953
```YML
5054
service: basic
@@ -65,23 +69,20 @@ functions:
6569
handler: handler.hello
6670
```
6771

68-
*Gemfile*
72+
*`Gemfile`*
6973

7074
```ruby
7175
source 'https://rubygems.org'
7276
gem 'http'
7377
gem 'nokogiri'
7478
```
7579

76-
7780
## Contributing
7881

79-
8082
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
8183

8284
Please make sure to update tests as appropriate.
8385

84-
8586
## License
8687

8788
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)