README.md 2.01 KB
Newer Older
1
# lib-ical
Mark Stenglein's avatar
Mark Stenglein committed
2

3
4
lib-ical is an npm library which implements the ical standard defined in RFC
5545.
Mark Stenglein's avatar
Mark Stenglein committed
5
6
7

## Getting Started

8
9
10
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.
Mark Stenglein's avatar
Mark Stenglein committed
11
12
13
14
15
16
17
18
19
20
21

### Prerequisites

What things you need to install the software and how to install them

```
Give examples
```

### Installing

22
23
A step by step series of examples that tell you have to get a development env
running
Mark Stenglein's avatar
Mark Stenglein committed
24
25
26
27
28
29
30
31
32
33
34
35
36

Say what the step will be

```
Give the example
```

And repeat

```
until finished
```

37
38
End with an example of getting some data out of the system or using it for a
little demo
Mark Stenglein's avatar
Mark Stenglein committed
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

## 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

* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
* [Maven](https://maven.apache.org/) - Dependency Management
* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds

## Contributing

72
73
74
75
Please read
[CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426)
for details on our code of conduct, and the process for submitting pull
requests to us.
Mark Stenglein's avatar
Mark Stenglein committed
76
77
78

## Versioning

79
80
We use [SemVer](http://semver.org/) for versioning. For the versions available,
see the [tags on this repository](https://github.com/your/project/tags).
Mark Stenglein's avatar
Mark Stenglein committed
81
82
83

## Authors

84
* **Mark Stenglein** - *Initial work* - [ocelotsloth](https://github.com/ocelotsloth)
Mark Stenglein's avatar
Mark Stenglein committed
85

86
87
See also the list of [contributors](https://git.gmu.edu/srct/lib-ical/contributors)
who participated in this project.
Mark Stenglein's avatar
Mark Stenglein committed
88
89
90

## License

91
92
This project is licensed under the AGPLv3 License - see the [LICENSE](LICENSE)
file for details
Mark Stenglein's avatar
Mark Stenglein committed
93
94
95
96
97
98
99

## Acknowledgments

* Hat tip to anyone who's code was used
* Inspiration
* etc