Skip to content

Commit

Permalink
Update README.md (#4350)
Browse files Browse the repository at this point in the history
  • Loading branch information
compSciKai authored and kmpoppe committed Nov 30, 2019
1 parent be9e63a commit c4afcc3
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,22 @@ A list of popular sites and whether or not they accept two factor auth.

## The Goal

The goal is to build a website ([TwoFactorAuth.org](https://twofactorauth.org)) with a list of popular sites that support
The goal of this project is to build a website ([TwoFactorAuth.org](https://twofactorauth.org)) with a list of popular sites that support
Two Factor Authentication, as well as the methods that they provide.

Our hope is to aid consumers who are deciding between alternative services based on the security they
offer for their customers. This can also serve as an indicator for the effort a site has put into security in general.
offer for their customers. This project also serves as an indicator of general security efforts used on a site.

## Contributing

If you'd like to contribute, read the entire guidelines here in
If you would like to contribute, please read the entire guidelines here in
[CONTRIBUTING.md][contrib].

## Running Locally

TwoFactorAuth.org is built upon [Jekyll](https://jekyllrb.com/), using the [github-pages](https://github.com/github/pages-gem) gem.
In order to run the site locally, it is necessary to install bundler, install all dependencies, and then use Jekyll to serve
the site. If the `gem` command is not available to you, it is necessary to install Ruby with RubyGems.
In order to run the site locally, bundler, and all other dependencies will need to be installed, and afterwards Jekyll can serve
the site. If the `gem` command is not available, Ruby with RubyGems needs to be installed.
Once Ruby and RubyGems are installed and available from the command line, TwoFactorAuth can be setup using the following commands.

```shell
Expand All @@ -41,9 +41,9 @@ If you're using Ubuntu or [Bash on Windows (WSL)](https://docs.microsoft.com/en-
sudo apt install build-essential ruby-bundler ruby-dev make gcc g++ zlib1g-dev
```

The TwoFactorAuth website should then be accessible from `http:https://localhost:4000`.
The TwoFactorAuth website should now be accessible from `http:https://localhost:4000`.

Another option is to run Jekyll inside a [Docker](https://www.docker.com/) container. Please read the [Jekyll Docker Documentation](https://github.com/envygeeks/jekyll-docker/blob/master/README.md) on how to do this.
Another option is to run Jekyll inside a [Docker](https://www.docker.com/) container. Please read the [Jekyll Docker Documentation](https://github.com/envygeeks/jekyll-docker/blob/master/README.md) on how to use Jekyll.

## License

Expand Down

0 comments on commit c4afcc3

Please sign in to comment.