Skip to content

Commit

Permalink
merged with master
Browse files Browse the repository at this point in the history
  • Loading branch information
JermyAker committed Mar 23, 2020
1 parent 47f9fd8 commit 6becaaa
Show file tree
Hide file tree
Showing 914 changed files with 6,314 additions and 2,844 deletions.
35 changes: 24 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ phildini@phildini.net. View the live website here:

## How do I add my company?

The short version is: the website is generated from the
[`companies.yml`](_data/companies.yml) file. Add the details of your
The short version is: the website is generated from files [in the `_data` directory](https://github.com/phildini/stayinghomeclub/tree/master/_data/). Add the details of your
company by mimicking what others have done, and create a PR. If
you're not familiar with Git or Pull Requests, here are the steps.
You will need a Github account.
Expand All @@ -20,12 +19,27 @@ You will need a Github account.
website. It is here on Github:
[`https://github.com/phildini/stayinghomeclub`](https://github.com/phildini/stayinghomeclub).

1. Find the `companies.yml` file, and click the "Edit" button. Here's
a [direct link to the Edit
page](https://github.com/phildini/stayinghomeclub/edit/master/_data/companies.yml).
1. You will need to create a YML file [in the `companies`
directory](https://github.com/phildini/stayinghomeclub/tree/master/_data/companies).
Navigate there, and click the "Create new file" button. Here's a
[direct link to the Create
page](https://github.com/phildini/stayinghomeclub/new/master/_data/companies).

1. Add your company, or update its details if something has changed. Please try
to put your new entry in roughly alphabetical order, by name, relative to existing companies.
Or, if you're just updating an existing entry, click on it, then
hit the "Edit" button.

1. Give the file a name, something like `google.yml` or `envato.yml` or `my-awesome-company.yml`
or `ing.yml`, no fancy or uppercase characters, and be sure to end it with
**.yml**. Add the details about your company in this format:

```yaml
name: Your company name
wfh: Strongly Encouraged
travel: Restricted
visitors: Restricted
events: Restricted
last_update: 2020-03-13
```
1. Click "Propose File Change", the big green button at the bottom of
the page.
Expand All @@ -36,7 +50,6 @@ You will need a Github account.
1. Thank you for helping us keep this site up-to-date! 🙏

## For developers
You may want to run the site locally, to see what it looks like while
Expand All @@ -46,19 +59,19 @@ these are the basic steps. We assume you know a little bit of Ruby.
First, you'll need Ruby Bundler, which manages this project's
dependencies.
```
```shell
gem install bundler -v 2.1.4
```

Now, install the required Gems.

```
```shell
bundle install
```

When that's done, run the development server.

```
```shell
bundle exec jekyll serve
```

Expand Down
Loading

0 comments on commit 6becaaa

Please sign in to comment.