diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..75f9a6e8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,40 @@ +# Compiled source # +################### +*.com +*.class +*.dll +*.exe +*.o +*.so + +# Packages # +############ +*.7z +*.dmg +*.gz +*.iso +*.jar +*.rar +*.tar +*.zip + +# Logs # +######## +*.log + +# OS generated files # +###################### +.DS_Store +.DS_Store? +._* +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db + +# Node specific # +################# +node_modules/ + +# App specific # +################ diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..a0bddcdd --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2017 xiaofan2406 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 00000000..8c084a7d --- /dev/null +++ b/README.md @@ -0,0 +1,100 @@ +# Nidalee · [![Build Status](https://img.shields.io/travis/npm/npm/latest.svg?style=flat-square)](https://travis-ci.org/npm/npm) [![npm](https://img.shields.io/npm/v/npm.svg?style=flat-square)](https://www.npmjs.com/package/npm) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/your/your-project/blob/master/LICENSE) + +> Additional information or tag line + +A brief description of your project, what it is used for. + +## Installing / Getting started + +A quick introduction of the minimal setup you need to get a hello world up & +running. + +```shell +commands here +``` + +Here you should say what actually happens when you execute the code above. + +## Developing + +### Built With + +List main libraries, frameworks used including versions (React, Angular etc...) + +### Prerequisites + +What is needed to set up the dev environment. For instance, global dependencies or any other tools. include download links. + +### Setting up Dev + +Here's a brief intro about what a developer must do in order to start developing +the project further: + +```shell +git clone https://github.com/your/your-project.git +cd your-project/ +packagemanager install +``` + +And state what happens step-by-step. If there is any virtual environment, local server or database feeder needed, explain here. + +### Building + +If your project needs some additional steps for the developer to build the +project after some code changes, state them here. for example: + +```shell +./configure +make +make install +``` + +Here again you should state what actually happens when the code above gets +executed. + +### Deploying / Publishing + +give instructions on how to build and release a new version +In case there's some step you have to take that publishes this project to a +server, this is the right time to state it. + +```shell +packagemanager deploy your-project -s server.com -u username -p password +``` + +And again you'd need to tell what the previous code actually does. + +## Versioning + +We can maybe use [SemVer](http://semver.org/) for versioning. For the versions available, see the [link to tags on this repository](/tags). + +## Configuration + +Here you should write what are all of the configurations a user can enter when +using the project. + +## Tests + +Describe and show how to run the tests with code examples. +Explain what these tests test and why. + +```shell +Give an example +``` + +## Style guide + +Explain your code style and show how to check it. + +## Api Reference + +If the api is external, link to api documentation. If not describe your api including authentication methods as well as explaining all the endpoints with their required parameters. + +## Database + +Explaining what database (and version) has been used. Provide download links. +Documents your database design and schemas, relations etc... + +## Licensing + +State what the license is and how to find the text version of the license. diff --git a/package.json b/package.json new file mode 100644 index 00000000..c6cea9be --- /dev/null +++ b/package.json @@ -0,0 +1,6 @@ +{ + "name": "nidalee", + "version": "0.0.0", + "main": "index.js", + "license": "MIT" +}