Skip to content

Commit

Permalink
update navi name and links in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
motosharpley committed Mar 17, 2018
1 parent 81ccf5a commit 8fa90d4
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 22 deletions.
14 changes: 7 additions & 7 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributions Welcome

Thanks for your interest in contributing to **Offline Google Maps Navigator**! Contributing to open source projects like this one can be a rewarding way to learn, teach, and build experience. Not only that, contributing is a great way to get involved with _social coding_. We are excited to see what amazing contributions you will make, as well as how your contributions will benefit others.
Thanks for your interest in contributing to **Navi**! Contributing to open source projects like this one can be a rewarding way to learn, teach, and build experience. Not only that, contributing is a great way to get involved with _social coding_. We are excited to see what amazing contributions you will make, as well as how your contributions will benefit others.

If you are new to contributing to open source projects, the process can be intimidating. Not to worry! To help ensure both you and the community get the most out of your contributions, we've put together the following guidelines.

Expand Down Expand Up @@ -76,13 +76,13 @@ To start making a contribution:
1. `clone` your forked repository (_noob tip: the actual command you type in is everything after the $_):

```shell
$ git clone https://github.com/<YOUR-USERNAME>/googleMaps-offline-navigator
$ git clone https://github.com/<YOUR-USERNAME>/Navi
```

1. Add a new remote that points to the original project so you can sync project changes with your local copy:

```shell
$ git remote add upstream https://github.com/TheDevPath/googleMaps-offline-navigator
$ git remote add upstream https://github.com/TheDevPath/Navi
```

1. Pull upstream changes into your local repositories `development` branch:
Expand Down Expand Up @@ -125,8 +125,8 @@ To start making a contribution:

Happy contributing!

[issues]: https://github.com/TheDevPath/googleMaps-offline-navigator/issues
[pull-requests]: https://github.com/TheDevPath/googleMaps-offline-navigator/pulls
[wiki]: https://github.com/TheDevPath/googleMaps-offline-navigator/wiki
[issues]: https://github.com/TheDevPath/Navi/issues
[pull-requests]: https://github.com/TheDevPath/Navi/pulls
[wiki]: https://thedevpath.github.io/Navi/
[code-of-conduct]: ./CODE_OF_CONDUCT.md
[about]: https://github.com/TheDevPath/googleMaps-offline-navigator/blob/static-docs/README.md
[about]: https://github.com/TheDevPath/Navi/blob/static-docs/README.md
15 changes: 8 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Getting Started
See the Guide on how to contribute [here](https://github.com/TheDevPath/googleMaps-offline-navigator/blob/development/CONTRIBUTING.md#how-to-contribute) for instructions on how to fork and set up your repository.
See the Guide on how to contribute [here](https://github.com/TheDevPath/Navi/blob/development/CONTRIBUTING.md#how-to-contribute) for instructions on how to fork and set up your repository.

# Installing Dependencies
In the root directory of your newly cloned project `npm install`
Expand Down Expand Up @@ -38,14 +38,14 @@ You also need to install and have running mongoDB - Directions can be found [her

# Update and run

When installation has completed go to where you installed the project and run `npm install` again to install the root and client dependencies. This will update the file package.json in the root of your project.
When update has completed go to where you installed the project and run `npm install` again to install dependencies in the root and client directories. This will update the project with any new packages added to the file package.json in your project.

When finished, in the project's root directory type `npm run dev`. This will start the dev servers on `localhost:8080` & `localhost:8081` respectively


# About googleMaps-offline-navigator
# About Navi

This is an open source project for Grow with Google Udacity Scholarship Challenge - Navigation app using offline first strategy and google maps api
This is an open source project for Grow with Google Udacity Scholarship Challenge - Navigation app using offline first strategy and Open Street Maps and google api

The idea for this project is to build a progressive web app utilizing the technologies learned in the Grow with Google Udacity Scholarship challenge.

Expand Down Expand Up @@ -107,13 +107,14 @@ The main goal of the app is to provide the user with a map interface that they c

### *About the application*
* Node backend
* React Frontend
* Google Maps api
* Preact Frontend
* Open Street Maps
* Google api
* Service Workers
* [MIT License](../blob/master/LICENSE)

### *Where to get the files*
* [This repository](https://github.com/TheDevPath/googleMaps-offline-navigator)
* [This repository](https://github.com/TheDevPath/Navi)

### *Key files included*
* Files
Expand Down
8 changes: 2 additions & 6 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<html>
<title>Google Offline Navigator: An open source project built for Grow with Google </title>
<title>Navi: An open source project built for Grow with Google </title>



Expand All @@ -10,18 +10,14 @@
Not only that, contributing is a great way to get involved with social coding. We are excited to see what amazing contributions you will make, as well as how your contributions will benefit others.
Here is how you can [contribute](CONTRIBUTING.md) and here is how you can get [set up](README.md) with the code base

## Wiki
The wiki is where you will find more information about the inner workings of this project. You will also find documentation about specific components here.
Check it [out](https://github.com/TheDevPath/googleMaps-offline-navigator/wiki)

## Learning Resources
This is where the team captures lessons learned, best practices and "gotchas" that may be of help to others - check it [out](learning.html)

## API and other Documentation
You will find more detailed documentation here including all the APIs used, associated instructions and end points

## Meet the team
Here are the [people](https://github.com/TheDevPath/googleMaps-offline-navigator/graphs/contributors) behind this project.
Here are the [people](https://github.com/TheDevPath/Navi/graphs/contributors) behind this project.

Special thanks to all the woderful [contributors](CONTRIBUTORS.html).

Expand Down
2 changes: 1 addition & 1 deletion docs/leaflet.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<html>
<title>Google Offline Navigator: An open source project built for Grow with Google </title>
<title>Navi: An open source project built for Grow with Google </title>



Expand Down
2 changes: 1 addition & 1 deletion docs/learning.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<html>
<title>Google Offline Navigator: An open source project built for Grow with Google </title>
<title>Navi: An open source project built for Grow with Google </title>



Expand Down

0 comments on commit 8fa90d4

Please sign in to comment.