Skip to content

Commit 031ef04

Browse files
HeidiSteenbrjohnstmsft
authored andcommitted
Initial draft of readme (#1)
* Initial draft of readme * Deleted change log, added readme metadata, extended target completion date
1 parent 0a229c4 commit 031ef04

File tree

3 files changed

+17
-71
lines changed

3 files changed

+17
-71
lines changed

CHANGELOG.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing to [project-title]
1+
# Contributing to Azure Search JavaScript Samples
22

33
This project welcomes contributions and suggestions. Most contributions require you to agree to a
44
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us

README.md

Lines changed: 16 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,16 @@
1-
# Project Name
2-
3-
(short, 1-3 sentenced, description of the project)
4-
5-
## Features
6-
7-
This project framework provides the following features:
8-
9-
* Feature 1
10-
* Feature 2
11-
* ...
12-
13-
## Getting Started
14-
15-
### Prerequisites
16-
17-
(ideally very short, if any)
18-
19-
- OS
20-
- Library version
21-
- ...
22-
23-
### Installation
24-
25-
(ideally very short)
26-
27-
- npm install [package name]
28-
- mvn install
29-
- ...
30-
31-
### Quickstart
32-
(Add steps to get up and running quickly)
33-
34-
1. git clone [repository clone url]
35-
2. cd [respository name]
36-
3. ...
37-
38-
39-
## Demo
40-
41-
A demo app is included to show how to use the project.
42-
43-
To run the demo, follow these steps:
44-
45-
(Add steps to start up the demo)
46-
47-
1.
48-
2.
49-
3.
50-
51-
## Resources
52-
53-
(Any additional resources or related projects)
54-
55-
- Link to supporting information
56-
- Link to similar sample
57-
- ...
1+
---
2+
topic: sample
3+
services: azure-search
4+
languages:
5+
- javascript
6+
name: Azure Search Sample Data
7+
description: |
8+
Find JavaScript samples for Azure Search in this repo.
9+
products:
10+
- azure-search
11+
---
12+
# Azure Search JavaScript Samples repository
13+
14+
This repository contains JavaScript sample code used in Azure Search quickstarts, tutorials, and examples.
15+
16+
We are currently in the process of migrating content to this repository. Target completion date for this work is end of April.

0 commit comments

Comments
 (0)