Commit de5533e0 authored by Mark Stenglein's avatar Mark Stenglein

Changes README to org-mode and actually wrote content

This readme was is a pretty sad state. It's still pretty bad still
but at least it has _something_ written in it.
Signed-off-by: Mark Stenglein's avatarMark Stenglein <mstengle@gmu.edu>
parent 34bf95ad
Pipeline #1099 passed with stages
in 51 seconds
# lib-ical
![](https://www.gnu.org/graphics/agplv3-155x51.png)
lib-ical is an npm library which implements the ical standard defined in RFC
5545.
## Getting Started
These instructions will get you a copy of the project up and running on your
local machine for development and testing purposes. See deployment for notes on
how to deploy the project on a live system.
### Prerequisites
For this repository, you will need nodejs and npm installed.
```
Give examples
```
### Installing
A step by step series of examples that tell you have to get a development env
running
Say what the step will be
```
Give the example
```
And repeat
```
until finished
```
End with an example of getting some data out of the system or using it for a
little demo
## Running the tests
Explain how to run the automated tests for this system
### Break down into end to end tests
Explain what these tests test and why
```
Give an example
```
### And coding style tests
Explain what these tests test and why
```
Give an example
```
## Deployment
Add additional notes about how to deploy this on a live system
## Built With
## Contributing
Please read
[CONTRIBUTING.md]()
for details on our code of conduct, and the process for submitting pull
requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available,
see the [tags on this repository](https://github.com/your/project/tags).
## Authors
* **Mark Stenglein** - *Initial work* - [ocelotsloth](https://github.com/ocelotsloth)
See also the list of [contributors](https://git.gmu.edu/srct/lib-ical/contributors)
who participated in this project.
## License
This project is licensed under the AGPLv3 License - see the [LICENSE](LICENSE)
file for details
## Acknowledgments
* Inspiration
* etc
* lib-ical
[[https://www.gnu.org/graphics/agplv3-155x51.png]]
lib-ical is an npm library which implements the ical standard defined in RFC
5545.
** Getting Started
*** Prerequisites
For this repository, you will need nodejs and npm installed.
*** Installing
Simply install with npm, and optionally save it to your dependencies:
** Running the tests
To run the test suite, simply clone the repository and run ~npm test~.
** Coding style
The linting rules defined in [[.tslint]] should be folled. The test suite does
(will) enforce this for all pull requests.
** Contributing
Please read
[[CONTRIBUTING.org]]
for details on our code of conduct, and the process for submitting pull
requests to us.
** Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available,
see the [tags on this repository](https://github.com/your/project/tags).
** Authors
- **Mark Stenglein** - *Initial work* - [[https://github.com/ocelotsloth][ocelotsloth]]
See also the list of [[https://git.gmu.edu/srct/lib-ical/contributors][contributors]]
who participated in this project.
** License
This project is licensed under the AGPLv3 License - see the [[LICENSE]]
file for details
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment