This repository has been archived by the owner on Jan 29, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#20 Initialize open source features for community
-- add minimal readme.md
- Loading branch information
1 parent
5e65ef6
commit faf2f7d
Showing
1 changed file
with
22 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,24 @@ | ||
# Cyber Search [![CircleCI](https://img.shields.io/circleci/project/github/cybercongress/cyber-search.svg?longCache=true&style=flat-square)](https://circleci.com/gh/cybercongress/cyber-search) [![Latest Release](https://img.shields.io/github/release/cybercongress/cyber-search.svg?longCache=true&style=flat-square)](https://circleci.com/gh/cybercongress/cyber-search) [![GitHub license](https://img.shields.io/github/license/cybercongress/cyber-search.svg?style=flat-square)](https://github.com/cybercongress/cyber-search/blob/master/LICENSE) | ||
|
||
Project status: beta Not all planned features are completed. The API, spec, status and other user facing objects may change. | ||
|
||
Search engine backend and API. | ||
|
||
[![CircleCI](https://img.shields.io/circleci/project/github/cybercongress/cyber-search.svg)](https://circleci.com/gh/cybercongress/cyber-search) | ||
## Getting Start Useful Links | ||
|
||
* [Development Quick Start Guide](./dev-environment/README.md) | ||
* [Architecture Overview](http://docs.cybernode.io/cybernode/components/search/) | ||
* [Api OpenAPI 3.0 Documentation](http://docs.cybersearch.io/) | ||
* [Api Test Server](http://api.cybersearch.io/search?query=42) | ||
* [Docker Images](https://hub.docker.com/r/cybernode/) | ||
* [Kubernetes Descriptors](https://github.com/cybercongress/cybernode/tree/master/kubernetes-definitions/search) | ||
|
||
## Issues | ||
|
||
If you have any problems with or questions about search, please contact us through a | ||
[GitHub issue](https://github.com/cybercongress/cyber-search/issues). | ||
|
||
## Contribute | ||
|
||
You are invited to contribute new features, fixes, or updates, large or small; We are always thrilled to receive pull | ||
requests, and do our best to process them as fast as We can. |